public class TLcdCollectedLabelInfoList extends Object
Constructor and Description |
---|
TLcdCollectedLabelInfoList() |
Modifier and Type | Method and Description |
---|---|
void |
addLabel(TLcdCollectedLabelInfo aLabel)
Adds the given label to this label infos object.
|
boolean |
containsLabel(ILcdLayer aLayer,
Object aObject,
int aLabelIndex,
int aSubLabelIndex)
Checks if this
TLcdCollectedLabelInfoList object contains the label identified by the given
ILcdLayer, Object, label index and sublabel index. |
boolean |
containsLabeledObject(ILcdLayer aLayer,
Object aObject)
Checks if this
TLcdCollectedLabelInfoList object contains the
TLcdCollectedLabeledObjectInfo identified by the given ILcdLayer and Object. |
TLcdCollectedLabelInfo |
getLabel(ILcdLayer aLayer,
Object aObject,
int aLabelIndex,
int aSubLabelIndex)
Returns the
TLcdCollectedLabelInfo object that corresponds with the given ILcdLayer,
Object, label index and sublabel index, or null if no such label info object could
be found. |
TLcdCollectedLabeledObjectInfo |
getLabeledObject(ILcdLayer aLayer,
Object aObject)
Returns a
TLcdCollectedLabeledObjectInfo for the given (ILcdLayer, Object) pair,
or null if no TLcdCollectedLabeledObjectInfo could be found. |
List<TLcdCollectedLabeledObjectInfo> |
getLabeledObjects()
Returns a list of
TLcdCollectedLabeledObjectInfo objects. |
List<TLcdCollectedLabelInfo> |
getLabels()
Returns the list of
TLcdCollectedLabelInfo objects. |
List<TLcdCollectedLabelInfo> |
getLabelsForLabeledObject(ILcdLayer aLayer,
Object aObject)
This method returns all
TLcdCollectedLabelInfo objects for the given labeled
object identified by the given ILcdLayer and Object . |
void |
mergeLabelInfoList(TLcdCollectedLabelInfoList aLabelInfoListSFCT)
This method merges the given
TLcdCollectedLabelInfoList into this object. |
void |
sortLabels(Comparator<TLcdCollectedLabelInfo> aComparator)
This method sorts the labels in this
TLcdCollectedLabelInfoList object using
the given comparator. |
public void addLabel(TLcdCollectedLabelInfo aLabel)
aLabel
- a label.public void sortLabels(Comparator<TLcdCollectedLabelInfo> aComparator)
TLcdCollectedLabelInfoList
object using
the given comparator.aComparator
- a given comparator.public void mergeLabelInfoList(TLcdCollectedLabelInfoList aLabelInfoListSFCT)
TLcdCollectedLabelInfoList
into this object. It also
makes sure that duplicate TLcdCollectedLabeledObjectInfo
objects are merged.
Because of this, it is possible that the given TLcdCollectedLabelInfoList
object
is adjusted. It will still contains the same TLcdCollectedLabelInfo
objects,
but some TLcdCollectedLabeledObjectInfo
objects may have changed.aLabelInfoListSFCT
- a TLcdCollectedLabelInfoList
.public List<TLcdCollectedLabelInfo> getLabels()
TLcdCollectedLabelInfo
objects. The labels are returned in an
unspecified order. Modifying the returned list will not have an influence on the internal
state of this class.TLcdCollectedLabelInfo
objects.public TLcdCollectedLabelInfo getLabel(ILcdLayer aLayer, Object aObject, int aLabelIndex, int aSubLabelIndex)
TLcdCollectedLabelInfo
object that corresponds with the given ILcdLayer,
Object, label index and sublabel index, or null
if no such label info object could
be found. A label can only be returned if it was added to this TLcdCollectedLabelInfoList
object, otherwise null
is returned.aLayer
- a layer.aObject
- an object.aLabelIndex
- a label index.aSubLabelIndex
- a sublabel index.TLcdCollectedLabelInfo
object that corresponds with the given Object, label
index and sublabel index, or null
if no such label could be found, or if a found
label was not added to this TLcdCollectedLabelInfoList
.public boolean containsLabel(ILcdLayer aLayer, Object aObject, int aLabelIndex, int aSubLabelIndex)
TLcdCollectedLabelInfoList
object contains the label identified by the given
ILcdLayer, Object, label index and sublabel index.aLayer
- a layer.aObject
- an object.aLabelIndex
- a label index.aSubLabelIndex
- a sublabel index.true
if this TLcdCollectedLabelInfoList
object contains the
label, and false
otherwise.public List<TLcdCollectedLabeledObjectInfo> getLabeledObjects()
TLcdCollectedLabeledObjectInfo
objects. These labels are retrieved
using all added TLcdCollectedLabelInfo
objects added to this object. The labeled objects
are returned in an unspecified order. Modifying the returned list will not have an influence
on the internal state of this class.TLcdCollectedLabeledObjectInfo
objects.public TLcdCollectedLabeledObjectInfo getLabeledObject(ILcdLayer aLayer, Object aObject)
TLcdCollectedLabeledObjectInfo
for the given (ILcdLayer, Object) pair,
or null
if no TLcdCollectedLabeledObjectInfo
could be found.aLayer
- a layer.aObject
- an object to be labeled.TLcdCollectedLabeledObjectInfo
for the given Object, or null
if no
TLcdCollectedLabeledObjectInfo
could be found.public boolean containsLabeledObject(ILcdLayer aLayer, Object aObject)
TLcdCollectedLabelInfoList
object contains the
TLcdCollectedLabeledObjectInfo
identified by the given ILcdLayer and Object.aLayer
- a layer.aObject
- an object.true
if this TLcdCollectedLabelInfoList
object contains the
TLcdCollectedLabeledObjectInfo
, and false
otherwise.public List<TLcdCollectedLabelInfo> getLabelsForLabeledObject(ILcdLayer aLayer, Object aObject)
TLcdCollectedLabelInfo
objects for the given labeled
object identified by the given ILcdLayer
and Object
.aLayer
- a layer.aObject
- a labeled object.TLcdCollectedLabelInfo
object for the given labeled object. If
no TLcdCollectedLabelInfo
can be found, an empty list is returned. Modifying
the returned List
has no influence on the inner working of this class.