

PREV CLASS NEXT CLASS  FRAMES NO FRAMES  
SUMMARY: NESTED  FIELD  CONSTR  METHOD  DETAIL: FIELD  CONSTR  METHOD 
L
 The type of Label with respect to which this
ClassSetLabelPatternInterface
has meaning.public interface ClassSetLabelPatternInterface<L extends LabelInterface>
An interface implemented by "class set" LabelPatterns.
The LabelPattern "class set," with respect to an Alphabet of the correct type, specifies the subset, S, of Labels in the Alphabet that have been explicitly specified as being included in S.
Labels can be added to the ClassSetLabelPattern, effectively specifying them as being included in S. Likewise, they can be removed, thus retracting such specification.
LabelPatterns can also be added to the ClassSetLabelPattern, specifying their participation in determining S. Likewise, such participation can be retracted by removing the LabelPatterns.
The subset S that ClassSetLabelPattern P specifies is defined as follows: With respect to an Alphabet of the correct type, A, S is the union of the subsets of A specified by each of the LabelPatterns included in P, unioned with the set of all Labels that are included in P and contained in A.
Note that when adding and removing Labels and LabelPatterns to and from the
ClassSetLabelPattern, simple tests for equality are used. Labels are only
compared to Labels via their equals
methods, and LabelPatterns
are only compared to LabelPatterns via their equals
methods.
Even though in the context of some Alphabet, a Label associated with this
ClassSetLabelPattern might also be in the subset specified by some
LabelPattern associated with this ClassSetLabelPattern, such relationships
are not considered when adding or removing Labels or LabelPatterns.
For example, consider Alphabet A containing Label L.
LabelPattern P, with respect to A, specifies the subset {L}.
If both L and P are specified as being included in some
ClassSetLabelPattern (by the addIncludedLabel
and
addIncludedLabelPattern
methods), and L is
subsequently removed (via the removeIncludedLabel
method),
then with respect to A, the subset the ClassSetLabelPattern
specifies still contains L because even though L itself
was removed from the ClassSetLabelPattern, the simple equality test does not
affect P's participation in the subset's specification.
laser.alphabetinterface.labelpatterninterface.LabelPatternInterface
Method Summary  

boolean 
addIncludedLabel(L label)
Specifies the given Label as being included in the subset this LabelPattern specifies. 
boolean 
addIncludedLabelPattern(LabelPatternInterface<L> labelPattern)
Specifies the given LabelPattern as participating in determining the subset this LabelPattern specifies. 
boolean 
addIncludedLabelPatterns(java.util.Set<? extends LabelPatternInterface<L>> labelPatterns)
Specifies each LabelPattern in the given Set as
participating in determining the subset this LabelPattern specifies. 
boolean 
addIncludedLabels(java.util.Set<? extends L> labels)
Specifies each Label in the given Set as being included in
the subset this LabelPattern specifies. 
java.util.Set<LabelPatternInterface<L>> 
getIncludedLabelPatterns()
Returns a Set containing all of the LabelPatterns
specified as participating in determining the subset this
ClassSetLabelPattern specifies. 
java.util.Set<L> 
getIncludedLabels()
Returns a Set containing all of the Labels specified as
being included in the subset this ClassSetLabelPattern specifies. 
boolean 
removeIncludedLabel(L label)
Removes the specification that the given Label is to be included in the subset this LabelPattern specifies. 
boolean 
removeIncludedLabelPattern(LabelPatternInterface<L> labelPattern)
Removes the specification that the given LabelPattern is to participate in determining the subset this LabelPattern specifies. 
boolean 
removeIncludedLabelPatterns(java.util.Set<? extends LabelPatternInterface<L>> labelPatterns)
Removes the specification that each LabelPattern in the given Set is to participate in determining the subset this
LabelPattern specifies. 
boolean 
removeIncludedLabels(java.util.Set<? extends L> labels)
Removes the specification that each Label in the given Set
is to be included in the subset this LabelPattern specifies. 
Methods inherited from interface laser.alphabet.labelpattern.LabelPatternInterface 

clone, equals, getMatchingLabels, hashCode 
Methods inherited from interface java.lang.Comparable 

compareTo 
Method Detail 

boolean addIncludedLabel(L label)
equals
method) is already specified as being so included,
false is returned and this ClassSetLabelPattern is unchanged,
otherwise true is returned.
label
 Label to be included.
java.lang.NullPointerException
 if the specified Label is null.boolean addIncludedLabels(java.util.Set<? extends L> labels)
Set
as being included in
the subset this LabelPattern specifies. If an equal Label (according to
its equals
method) to every Label in the given
Set
is already specified as being so included,
false is returned and this LabelPattern is unchanged,
otherwise true is returned.
labels
 Labels to be included.
equals
method) to every Label in the given
Set
is already specified as being included in the
subset this LabelPattern specifies, true otherwise.
java.lang.NullPointerException
 if the specified Set
or any Label it
contains is null.boolean addIncludedLabelPattern(LabelPatternInterface<L> labelPattern)
equals
method) is already so specified,
false is returned and this ClassSetLabelPattern is unchanged,
otherwise true is returned.
labelPattern
 LabelPattern to be included.
java.lang.NullPointerException
 if the specified LabelPattern is null.boolean addIncludedLabelPatterns(java.util.Set<? extends LabelPatternInterface<L>> labelPatterns)
Set
as
participating in determining the subset this LabelPattern specifies. If
an equal LabelPattern (according to its equals
method) to
every Label in the given Set
is already so specified,
false is returned and this LabelPattern is unchanged,
otherwise true is returned.
labelPatterns
 LabelPatterns to be included.
equals
method) to every Label in the given
Set
is already specified as participating in
determining the subset this LabelPattern specifies, true
otherwise.
java.lang.NullPointerException
 if the specified Set
or any LabelPattern it
contains is null.java.util.Set<L> getIncludedLabels()
Set
containing all of the Labels specified as
being included in the subset this ClassSetLabelPattern specifies. This
Set
is a copy, thus modifying it or any of the Labels it
contains has no effect on the ClassSetLabelPattern, nor does modifying
the ClassSetLabelPattern have any effect on the returned Set
or any of the Labels it contains.
Set
containing all of the Labels specified as
being included in the subset this ClassSetLabelPattern specifies.java.util.Set<LabelPatternInterface<L>> getIncludedLabelPatterns()
Set
containing all of the LabelPatterns
specified as participating in determining the subset this
ClassSetLabelPattern specifies. This Set
is a copy, thus
modifying it or any of the LabelPatterns it contains has no effect on the
ClassSetLabelPattern, nor does modifying the ClassSetLabelPattern have
any effect on the returned Set
or any of the LabelPatterns
it contains.
Set
containing all of the LabelPatterns
specified as participating in determining the subset this
ClassSetLabelPattern specifies.boolean removeIncludedLabel(L label)
equals
method) was specified as being so included,
true is returned, otherwise false is returned and
this ClassSetLabelPattern is unchanged.
label
 Label no longer to be included.
java.lang.NullPointerException
 if the specified Label is null.boolean removeIncludedLabels(java.util.Set<? extends L> labels)
Set
is to be included in the subset this LabelPattern specifies. If an equal
Label (according to its equals
method) to any Label in the
given Set
was specified as being so included,
true is returned, otherwise false is returned and
this LabelPattern is unchanged.
labels
 Labels no longer to be included.
equals
method) to any Label in the given
Set
was specified as being included in the subset
this LabelPattern specifies, false otherwise.
java.lang.NullPointerException
 if the specified Set
or any Label it
contains is null.boolean removeIncludedLabelPattern(LabelPatternInterface<L> labelPattern)
equals
method) was so
specified, true is returned, otherwise false is
returned and this ClassSetLabelPattern is unchanged.
labelPattern
 LabelPattern no longer to be included.
java.lang.NullPointerException
 if the specified LabelPattern is null.boolean removeIncludedLabelPatterns(java.util.Set<? extends LabelPatternInterface<L>> labelPatterns)
Set
is to participate in determining the subset this
LabelPattern specifies. If an equal LabelPattern (according to its
equals
method) to any of the LabelPatterns in the given
Set
was so specified, true is returned,
otherwise false is returned and this ClassSetLabelPattern is
unchanged.
labelPatterns
 LabelPatterns no longer to be included.
equals
method) to any of the LabelPatterns in the
given Set
was specified as participating in
determining the subset this LabelPattern specifies,
false otherwise.
java.lang.NullPointerException
 if the specified Set
or any LabelPattern it
contains is null.


PREV CLASS NEXT CLASS  FRAMES NO FRAMES  
SUMMARY: NESTED  FIELD  CONSTR  METHOD  DETAIL: FIELD  CONSTR  METHOD 