Class TLcdGML32Model
- All Implemented Interfaces:
ILcdDataObject
,ILcd2DBoundsIndexedModel
,ILcd2DBoundsInteractable
,ILcdIntegerIndexedModel
,ILcdModel
,ILcdModelContainer
,ILcdModelProducerListener
,ILcdModelTreeNode
,ILcdBounded
,ILcdShape
,ILcdShapeList
,ILcdLockDependent
,ILcdCloneable
,ILcdDeepCloneable
,ILcdDisposable
,ILcdInvalidateable
,Serializable
,AutoCloseable
,Cloneable
,EventListener
TLcdGML32AbstractFeature
-based feature collection that implements ILcdModel
.
This requires the data type to have a feature property
.- Since:
- 9.0
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface com.luciad.model.ILcdModel
ILcdModel.Query
-
Field Summary
Modifier and TypeFieldDescriptionstatic final TLcdDataProperty
Data property that maps to theboundedBy
element.static final TLcdDataProperty
Data property that maps to thelocation
element.Fields inherited from class com.luciad.format.gml32.model.TLcdGML32AbstractGML
DESCRIPTION_PROPERTY, DESCRIPTION_REFERENCE_PROPERTY, ID_PROPERTY, IDENTIFIER_PROPERTY, META_DATA_PROPERTY_PROPERTY, NAME_PROPERTY
Fields inherited from interface com.luciad.model.ILcdModel
FIRE_LATER, FIRE_NOW, NO_EVENT
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addElement
(Object aElement, int aEventMode) Adds the specified element to this model.void
addElements
(Vector aElements, int aEventMode) Adds all of the elements in the specified vector to this model.void
addHierarchyModelContainerListener
(ILcdModelContainerListener aModelContainerListener) Registers the givenILcdModelContainerListener
to receiveTLcdModelContainerEvent
s from all theILcdModelTreeNode
s contained in the tree with this node as root node.void
addHierarchyModelListener
(ILcdModelListener aModelListener) Registers the givenILcdModelListener
to receiveTLcdModelChangedEvent
s from all theILcdModel
s contained in the tree with this node as root node.boolean
Adds theILcdModel aModel
as a child model to thisILcdModelTreeNode
.void
addModelContainerListener
(ILcdModelContainerListener aModelContainerListener) Adds anILcdModelContainerListener
to thisILcdModelContainer
.void
addModelListener
(ILcdModelListener aModelListener) Registers the specified model listener to receive notifications of model changes on this model.int
applyOnInteract2DBounds
(ILcdBounds aBounds, boolean aStrictOverlap, ILcdFunction aFunctionToApply, double aPrecisionX, double aPrecisionY) Applies the specified function to all the model elements of which the 2D bounds overlap with the specified bounds.int
applyOnInteract2DBounds
(ILcdBounds aBounds, boolean aStrictOverlap, ILcdFunction aFunctionToApply, double aPrecisionX, double aPrecisionY, double aMinSizeX, double aMinSizeY, boolean aIncludePoints) Applies the specified function to all the elements of which the 2D bounds overlap with the specified bounds.boolean
canAddElement
(Object aElement) Returnstrue
if the specified element can be added to this model,false
otherwise.boolean
canRemoveElement
(Object aElement) Returnstrue
if the specified element can be removed from this model,false
otherwise.Returns a deep clone of this object.void
dispose()
Disposes of this model and allows it to release any system resources that it is holding.elementAt
(int aIndex) Returns the element at the specified index.void
elementChanged
(Object aElement, int aEventMode) Notifies this model that the specified element has changed.elements()
Returns an enumeration over all elements of this model.void
elementsChanged
(Vector aElements, int aEventMode) Notifies this model that the elements in the specified vector have changed.void
Notifies all listeners that are registered on this model of all the changes that have been collected between the previous notification and now.Returns the value of the property that maps to theboundedBy
element.Returns theILcdBounds
by which the geometry of thisILcdBounded
object is bounded.Returns the objects that must be locked along with this object.Returns the value of the property that maps to thelocation
element.getModel
(int aIndex) Returns the child model at the given index.Returns theILcdModelDescriptor
providing meta information about this model and its elements.Returns, if available, a model encoder that is capable of encoding this model, (encoder.canEncode(this)
),null
otherwise.Collects and returns metadata about the model.Returns theILcdModelReference
describing how the geometry of the elements contained in this model should be interpreted.int
Returns the index of the first occurrence of the specified element in the model, or -1 if this model does not contain the element.void
boolean
isEmpty()
Returnstrue
when the model node is only used as a container for other models, and contains no useful data itself,false
otherwise.int
Returns the number of child models of this model node.void
modelProduced
(TLcdModelProducerEvent aModelProducerEvent) Notifies this ILcdModelProducerListener of a produced model.models()
Returns anEnumeration
of the child models of thisILcdModelTreeNode
.void
removeAllElements
(int aEventMode) Removes all elements from this model.void
removeElement
(Object aElement, int aEventMode) Removes the specified element from this model.void
removeElements
(Vector aElements, int aEventMode) Removes all of the elements in the specified vector from this model.void
removeHierarchyModelContainerListener
(ILcdModelContainerListener aModelContainerListener) Unregisters the givenILcdModelContainerListener
from receivingTLcdModelContainerEvent
s for the tree with this node as root node.void
removeHierarchyModelListener
(ILcdModelListener aModelListener) Unregisters the givenILcdModelListener
from receivingTLcdModelChangedEvent
s for the tree with this node as root node.boolean
removeModel
(ILcdModel aModel) Removes the child modelaModel
from thisILcdModelTreeNode
.void
removeModelContainerListener
(ILcdModelContainerListener aModelContainerListener) Removes anILcdModelContainerListener
from thisILcdModelContainer
.void
removeModelListener
(ILcdModelListener aModelListener) Unregisters the specified model listener so that it no longer receives notifications of model changes on this model.void
setBoundedBy
(TLcdGML32BoundingShape aValue) Sets the value of the property that maps to theboundedBy
element.void
setLocation
(Object aValue) Sets the value of the property that maps to thelocation
element.void
setModelDescriptor
(TLcdGML32ModelDescriptor aModelDescriptor) void
setModelReference
(ILcdModelReference aModelReference) int
size()
Returns the number of elements in this model.Methods inherited from class com.luciad.format.gml32.model.TLcdGML32AbstractFeature
clone, collectShapes, contains2D, contains2D, contains3D, contains3D, getFocusPoint, getShape, getShapeCount, invalidateObject, shapesChanged
Methods inherited from class com.luciad.format.gml32.model.TLcdGML32AbstractGML
getDescription, getDescriptionReference, getId, getIdentifier, getMetaDataProperty, getName, setDescription, setDescriptionReference, setId, setIdentifier
Methods inherited from class com.luciad.datamodel.TLcdDataObject
getDataType, getValue, getValue, hasValue, hasValue, setValue, setValue, toString
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.luciad.model.ILcd2DBoundsIndexedModel
query
Methods inherited from interface com.luciad.util.ILcdDisposable
close
Methods inherited from interface com.luciad.model.ILcdModelContainer
getModels
-
Field Details
-
BOUNDED_BY_PROPERTY
Data property that maps to theboundedBy
element. The possible values for this property are instances ofTLcdGML32BoundingShape
. -
LOCATION_PROPERTY
Data property that maps to thelocation
element. The possible values for this property are instances ofTLcdGML32LocationProperty
.
-
-
Constructor Details
-
TLcdGML32Model
- Parameters:
aType
- aTLcdGML32AbstractFeature
type with a property of typeTLcdGML32DataTypes.AbstractFeatureMemberType
-
-
Method Details
-
invalidateModel
public void invalidateModel() -
setModelReference
-
setModelDescriptor
-
addHierarchyModelContainerListener
Description copied from interface:ILcdModelTreeNode
Registers the given
ILcdModelContainerListener
to receiveTLcdModelContainerEvent
s from all theILcdModelTreeNode
s contained in the tree with this node as root node. If the listener should only receive events originating from this model node, it should be adedd as a regular model listener (seeILcdModelTreeNode.addModelContainerListener(ILcdModelContainerListener)
).The source
ILcdModelContainer
of the event can be retrieved by callingTLcdModelContainerEvent.getModelContainer()
on the receivedTLcdModelContainerEvent
.- Specified by:
addHierarchyModelContainerListener
in interfaceILcdModelTreeNode
- Parameters:
aModelContainerListener
- the listener- See Also:
-
addHierarchyModelListener
Description copied from interface:ILcdModelTreeNode
Registers the given
ILcdModelListener
to receiveTLcdModelChangedEvent
s from all theILcdModel
s contained in the tree with this node as root node. If the listener should only receive events originating from this model node, it should be added as a regular model listener (seeILcdModelTreeNode.addModelListener(ILcdModelListener)
).The source
ILcdModel
of the event can be retrieved by callingTLcdModelChangedEvent.getModel()
on the receivedTLcdModelChangedEvent
.- Specified by:
addHierarchyModelListener
in interfaceILcdModelTreeNode
- Parameters:
aModelListener
- the listener- See Also:
-
removeHierarchyModelContainerListener
public void removeHierarchyModelContainerListener(ILcdModelContainerListener aModelContainerListener) Description copied from interface:ILcdModelTreeNode
Unregisters the given
ILcdModelContainerListener
from receivingTLcdModelContainerEvent
s for the tree with this node as root node.- Specified by:
removeHierarchyModelContainerListener
in interfaceILcdModelTreeNode
- Parameters:
aModelContainerListener
- the listener- See Also:
-
removeHierarchyModelListener
Description copied from interface:ILcdModelTreeNode
Unregisters the given
ILcdModelListener
from receivingTLcdModelChangedEvent
s for the tree with this node as root node.- Specified by:
removeHierarchyModelListener
in interfaceILcdModelTreeNode
- Parameters:
aModelListener
- the listener- See Also:
-
addModel
Description copied from interface:ILcdModelTreeNode
Adds the
ILcdModel aModel
as a child model to thisILcdModelTreeNode
.- Specified by:
addModel
in interfaceILcdModelContainer
- Specified by:
addModel
in interfaceILcdModelTreeNode
- Parameters:
aModel
- the model to be added.- Returns:
true
if this collection of models changed as a result of the call
-
addModelContainerListener
Description copied from interface:ILcdModelTreeNode
Adds anILcdModelContainerListener
to thisILcdModelContainer
.It will only receive notifications of changes in this
.ILcdModelTreeNode
and not of any changes in the state of the child model node(s). If this is required, the listener must be registered as a hierarchy listener (seeILcdModelTreeNode.addHierarchyModelContainerListener(ILcdModelContainerListener)
).- Specified by:
addModelContainerListener
in interfaceILcdModelContainer
- Specified by:
addModelContainerListener
in interfaceILcdModelTreeNode
- Parameters:
aModelContainerListener
- the listener to be added.- See Also:
-
getModel
Description copied from interface:ILcdModelTreeNode
Returns the child model at the given index.
- Specified by:
getModel
in interfaceILcdModelContainer
- Specified by:
getModel
in interfaceILcdModelTreeNode
- Parameters:
aIndex
- a valid index in thisILcdModelTreeNode
- Returns:
- the child model at the given index.
-
modelCount
public int modelCount()Description copied from interface:ILcdModelTreeNode
Returns the number of child models of this model node.
- Specified by:
modelCount
in interfaceILcdModelContainer
- Specified by:
modelCount
in interfaceILcdModelTreeNode
- Returns:
- the number of child models of this model node.
-
models
Description copied from interface:ILcdModelTreeNode
Returns an
Enumeration
of the child models of thisILcdModelTreeNode
.- Specified by:
models
in interfaceILcdModelContainer
- Specified by:
models
in interfaceILcdModelTreeNode
- Returns:
- an
Enumeration
of the child models of thisILcdModelTreeNode
.
-
removeModel
Description copied from interface:ILcdModelTreeNode
Removes the child model
aModel
from thisILcdModelTreeNode
.- Specified by:
removeModel
in interfaceILcdModelContainer
- Specified by:
removeModel
in interfaceILcdModelTreeNode
- Parameters:
aModel
- the model to be removed.- Returns:
true
if a model was removed as a result of this call
-
removeModelContainerListener
Description copied from interface:ILcdModelTreeNode
Removes anILcdModelContainerListener
from thisILcdModelContainer
.It is not possible to remove a hierarchy model container listener. Use
ILcdModelTreeNode.removeHierarchyModelContainerListener(ILcdModelContainerListener)
for this purpose.- Specified by:
removeModelContainerListener
in interfaceILcdModelContainer
- Specified by:
removeModelContainerListener
in interfaceILcdModelTreeNode
- Parameters:
aModelContainerListener
- the listener to be removed.- See Also:
-
modelProduced
Description copied from interface:ILcdModelProducerListener
Notifies this ILcdModelProducerListener of a produced model.- Specified by:
modelProduced
in interfaceILcdModelProducerListener
- Parameters:
aModelProducerEvent
- the event describing the changes to aILcdModelProducer
.
-
isEmpty
public boolean isEmpty()Description copied from interface:ILcdModelTreeNode
Returns
true
when the model node is only used as a container for other models, and contains no useful data itself,false
otherwise.- Specified by:
isEmpty
in interfaceILcdModelTreeNode
- Returns:
true
when the model node contains no useful data,false
otherwise
-
applyOnInteract2DBounds
public int applyOnInteract2DBounds(ILcdBounds aBounds, boolean aStrictOverlap, ILcdFunction aFunctionToApply, double aPrecisionX, double aPrecisionY) Description copied from interface:ILcd2DBoundsIndexedModel
Applies the specified function to all the model elements of which the 2D bounds overlap with the specified bounds. By default, the order in which the function is applied on the elements is unspecified and depends on the implementation. The return value of the specified function is used as a stop criterion: the spatial query is interrupted if the function returnsfalse
.- Specified by:
applyOnInteract2DBounds
in interfaceILcd2DBoundsIndexedModel
- Parameters:
aBounds
- the rectangle to test overlap with.aStrictOverlap
- iffalse
, the spatial search may return more elements than the ones strictly overlapping; iftrue
, the search only returns the elements that are overlapping. The latter mode is more precise, but it may be slower.aFunctionToApply
- the function to apply on each element that overlaps with the given bounds. The return value of the specified function is used as a stop criterion: the spatial query is interrupted if the function returnsfalse
.aPrecisionX
- the precision required in the x dimension, expressed in model units. For example, for a cartesian grid system expressed in meters, the values should be expressed in meters as well, for a geodetic coordinate system the accuracy values should be expressed in degrees.The precision is useful in combination with multi-leveled data (multiple representations of the same object, but with varying accuracy), so that the most appropriate accuracy level can be used. 0 means best possible accuracy, but it might trigger lazy-loaded implementations to load lots of data.
aPrecisionY
- the precision required in the y dimension, expressed in model units.- Returns:
- the number of elements to which the
ILcdFunction
has been applied.
-
applyOnInteract2DBounds
public int applyOnInteract2DBounds(ILcdBounds aBounds, boolean aStrictOverlap, ILcdFunction aFunctionToApply, double aPrecisionX, double aPrecisionY, double aMinSizeX, double aMinSizeY, boolean aIncludePoints) Description copied from interface:ILcd2DBoundsInteractable
Applies the specified function to all the elements of which the 2D bounds overlap with the specified bounds. The order in which the function is applied on the elements is unspecified and depends on the implementation. Only elements that have at least the specified minimal size in the x dimension or in the y dimension are considered. This can be useful for quickly eliminating elements that are too small to be visible in a view, for instance. If required, an exception can be made for point elements, which have a size of 0 by 0. They can be forced to be considered, even though they would always be rejected as being too small for any sizes larger than 0. The return value of the specified function is used as a stop criterion: the spatial query will be interrupted as soon as the function returnsfalse
for an element it was applied on.- Specified by:
applyOnInteract2DBounds
in interfaceILcd2DBoundsIndexedModel
- Specified by:
applyOnInteract2DBounds
in interfaceILcd2DBoundsInteractable
- Parameters:
aBounds
- the rectangle to test overlap with.aStrictOverlap
- iffalse
, the spatial search may return more elements than the ones strictly overlapping; iftrue
, the search only returns the elements that are overlapping. The latter mode is more precise, but it may be slower.aFunctionToApply
- the function to apply on each element that overlaps with the given bounds.aPrecisionX
- the precision required in the x dimension, expressed in model units. For example, for a cartesian grid system expressed in meters, the values should be expressed in meters as well, for a geodetic coordinate system the accuracy values should be expressed in degrees.The precision is useful in combination with multi-leveled data (multiple representations of the same object, but with varying accuracy), so that the most appropriate accuracy level can be used. 0 means best possible accuracy, but it might trigger lazy-loaded implementations to load lots of data.
aPrecisionY
- the precision required in the y dimension, expressed in model units.aMinSizeX
- the minimal element size in the x dimension (as inILcdBounds.getWidth()
), expressed in model units. Elements that are smaller than this size will be skipped. This may, for example, be useful when improving the efficiency of painting elements by skipping elements that are smaller than some threshold (e.g. one pixel, converted to model units).aMinSizeY
- the minimal element size in the y dimension (as inILcdBounds.getHeight()
), expressed in model units.aIncludePoints
- iftrue
, zero-sized elements (points) are considered as well, even though they might be smaller than the minimum size.- Returns:
- the number of elements to which the
ILcdFunction
has been applied.
-
elementAt
Description copied from interface:ILcdIntegerIndexedModel
Returns the element at the specified index.- Specified by:
elementAt
in interfaceILcdIntegerIndexedModel
- Parameters:
aIndex
- an index into thisILcdModel
.- Returns:
- the element at the specified index.
-
size
public int size()Description copied from interface:ILcdIntegerIndexedModel
Returns the number of elements in this model.- Specified by:
size
in interfaceILcdIntegerIndexedModel
- Returns:
- the number of elements in this model.
-
indexOf
Description copied from interface:ILcdIntegerIndexedModel
Returns the index of the first occurrence of the specified element in the model, or -1 if this model does not contain the element. More formally: returns the smallesti
for whichthis.elementAt(i).equals(aElement)
.- Specified by:
indexOf
in interfaceILcdIntegerIndexedModel
- Parameters:
aElement
- the element to search for.- Returns:
- the index of the first occurrence of the specified element in model vector, or -1 if this model does not contain the element.
-
getBounds
Description copied from interface:ILcdBounded
Returns theILcdBounds
by which the geometry of thisILcdBounded
object is bounded.If the geometry does not allow retrieving valid bounds (for example a polyline with 0 points) the return value is unspecified. It is highly recommended to return an
undefined
bounds. You can create undefined bounds using the default constructors ofTLcdLonLatBounds
orTLcdXYBounds
.- Specified by:
getBounds
in interfaceILcdBounded
- Overrides:
getBounds
in classTLcdGML32AbstractFeature
- Returns:
- the
ILcdBounds
by which the geometry of thisILcdBounded
object is bounded.
-
getModelReference
Description copied from interface:ILcdModel
Returns theILcdModelReference
describing how the geometry of the elements contained in this model should be interpreted.- Specified by:
getModelReference
in interfaceILcdModel
- Specified by:
getModelReference
in interfaceILcdModelTreeNode
- Returns:
- the
ILcdModelReference
of thisILcdModel
.
-
getModelDescriptor
Description copied from interface:ILcdModel
Returns theILcdModelDescriptor
providing meta information about this model and its elements.- Specified by:
getModelDescriptor
in interfaceILcdModel
- Specified by:
getModelDescriptor
in interfaceILcdModelTreeNode
- Returns:
- the
ILcdModelDescriptor
of thisILcdModel
. Should not benull
.
-
getModelEncoder
Description copied from interface:ILcdModel
Returns, if available, a model encoder that is capable of encoding this model, (encoder.canEncode(this)
),null
otherwise.- Specified by:
getModelEncoder
in interfaceILcdModel
- Specified by:
getModelEncoder
in interfaceILcdModelTreeNode
- Returns:
- a model encoder that is capable of encoding this model if available,
null
otherwise.
-
getModelMetadata
Description copied from interface:ILcdModel
Collects and returns metadata about the model. Note that this method does not necessarily return the sameTLcdModelMetadata
instance every time it is called. The default implementation usesTLcdModelMetadata.Builder.fromModel(com.luciad.model.ILcdModel)
.Implementations can
recreate
orextend
the metadata. The following example adds a data category and source file mime type:public TLcdModelMetadata getModelMetadata() { String source = this.getModelDescriptor().getSourceName(); return this.getModelMetadata().asBuilder() .entryPoint(new TLcdModelMetadata.Source(source, MIME_XML)) .addDataCategory(TLcdModelMetadata.DataCategory.VECTOR) .build(); }
- Specified by:
getModelMetadata
in interfaceILcdModel
- Returns:
- Metadata about the model.
-
elements
Description copied from interface:ILcdModel
Returns an enumeration over all elements of this model. The order in which the elements are enumerated is unspecified by default.- Specified by:
elements
in interfaceILcdModel
- Specified by:
elements
in interfaceILcdModelTreeNode
- Returns:
- an enumeration over all elements of this model.
-
addElement
Description copied from interface:ILcdModel
Adds the specified element to this model.Models that support this operation may place limitations on what elements may be added to this model. For example, implementations that are based on a spatial indexing structure will require that elements implement
ILcdBounded
.When adding an element, the user should make sure that
canAddElement(aElement)
holds, and that the element's geometry is expressed in the same model reference as this model. It is generally undefined what happens if an invalid element is added.Implementations of this interface should clearly specify in their documentation any restrictions on what elements may be added. Although it is unspecified what happens if the preconditions are not met, implementations are encouraged to throw meaningful exceptions (for example,
NullPointerException, IllegalArgumentException, ClassCastException, UnsupportedOperationException
), whenever possible.- Specified by:
addElement
in interfaceILcdModel
- Specified by:
addElement
in interfaceILcdModelTreeNode
- Parameters:
aElement
- the element to be added to this model.aEventMode
- the mode for sending out the model change event. This can beFIRE_LATER
orNO_EVENT
.- See Also:
-
canAddElement
Description copied from interface:ILcdModel
Returnstrue
if the specified element can be added to this model,false
otherwise.Note that this method generally does not validate whether the specified element is expressed in the same model reference as this model. It is the responsibility of the user of this model to make sure this precondition is fulfilled when an element is added to this model.
- Specified by:
canAddElement
in interfaceILcdModel
- Specified by:
canAddElement
in interfaceILcdModelTreeNode
- Parameters:
aElement
- the element to be verified.- Returns:
true
if the specified element can be added to this model,false
otherwise.
-
addElements
Description copied from interface:ILcdModel
Adds all of the elements in the specified vector to this model. Models that support this operation may place limitations on what elements may be added to this model. For example, implementations that are based on a spatial indexing structure will require that elements implementILcdBounded
. Implementations of this interface should clearly specify in their documentation any restrictions on what elements may be added.The behavior of this operation is undefined if the specified vector is modified while the operation is in progress.
The specified elements will be added to this model in the order they are specified in the vector. If an element cannot be added, this method will return at the first failure. Succeeding elements won't be added.
Although it is unspecified what happens if the preconditions are not met, implementations are encouraged to throw meaningful exceptions (for example,
NullPointerException, IllegalArgumentException, ClassCastException, UnsupportedOperationException
), whenever possible.- Specified by:
addElements
in interfaceILcdModel
- Specified by:
addElements
in interfaceILcdModelTreeNode
- Parameters:
aElements
- the vector of elements to be added to this model.aEventMode
- the mode for sending the model change events This can beFIRE_LATER
orNO_EVENT
.- See Also:
-
removeElement
Description copied from interface:ILcdModel
Removes the specified element from this model. If the specified element is not contained in this model, this method has no effect.Although it is unspecified what happens if the preconditions are not met, implementations are encouraged to throw meaningful exceptions (for example,
NullPointerException, IllegalArgumentException, ClassCastException, UnsupportedOperationException
), whenever possible.- Specified by:
removeElement
in interfaceILcdModel
- Specified by:
removeElement
in interfaceILcdModelTreeNode
- Parameters:
aElement
- the element to be removed from this model.aEventMode
- the mode for sending out the model change event. This can beFIRE_LATER
orNO_EVENT
.- See Also:
-
canRemoveElement
Description copied from interface:ILcdModel
Returnstrue
if the specified element can be removed from this model,false
otherwise. Note that this method generally does not check whether the specified element is actually contained in this model.- Specified by:
canRemoveElement
in interfaceILcdModel
- Specified by:
canRemoveElement
in interfaceILcdModelTreeNode
- Parameters:
aElement
- the element to be verified.- Returns:
true
if the specified element can be removed from this model,false
otherwise.
-
removeElements
Description copied from interface:ILcdModel
Removes all of the elements in the specified vector from this model. If one of the elements in the specified vector is not contained in this model, this element will be ignored.The behavior of this operation is undefined if the specified vector is modified while the operation is in progress.
The specified elements will be removed from this model in the order they are specified in the vector. If an element cannot be removed, this method will return at the first failure. Succeeding elements won't be removed.
Although it is unspecified what happens if the preconditions are not met, implementations are encouraged to throw meaningful exceptions (for example,
NullPointerException, IllegalArgumentException, ClassCastException, UnsupportedOperationException
), whenever possible.- Specified by:
removeElements
in interfaceILcdModel
- Specified by:
removeElements
in interfaceILcdModelTreeNode
- Parameters:
aElements
- the vector of elements to be removed from this model.aEventMode
- the mode for sending out the model change event. This can beFIRE_LATER
orNO_EVENT
.- See Also:
-
removeAllElements
public void removeAllElements(int aEventMode) Description copied from interface:ILcdModel
Removes all elements from this model.If an element cannot be removed, this method will return at the first failure. Succeeding elements won't be removed.
Although it is unspecified what happens if the preconditions are not met, implementations are encouraged to throw meaningful exceptions (for example,
NullPointerException, IllegalArgumentException, ClassCastException, UnsupportedOperationException
), whenever possible.- Specified by:
removeAllElements
in interfaceILcdModel
- Specified by:
removeAllElements
in interfaceILcdModelTreeNode
- Parameters:
aEventMode
- the mode for sending out the model change event. This can beFIRE_LATER
orNO_EVENT
.
-
elementChanged
Description copied from interface:ILcdModel
Notifies this model that the specified element has changed.- Specified by:
elementChanged
in interfaceILcdModel
- Specified by:
elementChanged
in interfaceILcdModelTreeNode
- Parameters:
aElement
- the element that has changed.aEventMode
- the mode for sending out the model change event. This can beFIRE_LATER
orNO_EVENT
.
-
elementsChanged
Description copied from interface:ILcdModel
Notifies this model that the elements in the specified vector have changed.- Specified by:
elementsChanged
in interfaceILcdModel
- Specified by:
elementsChanged
in interfaceILcdModelTreeNode
- Parameters:
aElements
- the vector of elements that have changed.aEventMode
- the mode for sending out the model change event. This can beFIRE_LATER
orNO_EVENT
.
-
fireCollectedModelChanges
public void fireCollectedModelChanges()Description copied from interface:ILcdModel
Notifies all listeners that are registered on this model of all the changes that have been collected between the previous notification and now.- Specified by:
fireCollectedModelChanges
in interfaceILcdModel
- Specified by:
fireCollectedModelChanges
in interfaceILcdModelTreeNode
- See Also:
-
addModelListener
Description copied from interface:ILcdModel
Registers the specified model listener to receive notifications of model changes on this model.
Model changes are sent out when an element has been added, removed or changed. Model changes can be sent out individually, grouped or silently applied without notifications, depending on the
ILcdFireEventMode
that was specified with the change.In case you need to register a listener which keeps a reference to an object with a shorter life-time than this model, you can use a
ALcdWeakModelListener
instance as model listener.- Specified by:
addModelListener
in interfaceILcdModel
- Specified by:
addModelListener
in interfaceILcdModelTreeNode
- Parameters:
aModelListener
- theILcdModelListener
to register on this model.- See Also:
-
removeModelListener
Description copied from interface:ILcdModel
Unregisters the specified model listener so that it no longer receives notifications of model changes on this model.- Specified by:
removeModelListener
in interfaceILcdModel
- Specified by:
removeModelListener
in interfaceILcdModelTreeNode
- Parameters:
aModelListener
- theILcdModelListener
to remove.- See Also:
-
dispose
public void dispose()Description copied from interface:ILcdModel
Disposes of this model and allows it to release any system resources that it is holding. The result of calling any other method (other thanfinalize
) on this model subsequent to a call to this method is undefined.- Specified by:
dispose
in interfaceILcdDisposable
- Specified by:
dispose
in interfaceILcdModel
- Specified by:
dispose
in interfaceILcdModelTreeNode
-
getDependentObjects
Description copied from interface:ILcdLockDependent
Returns the objects that must be locked along with this object.TLcdLockUtil
first locks all objects returned by this method before locking this object.- Specified by:
getDependentObjects
in interfaceILcdLockDependent
- Returns:
- the objects that must be locked along with this object.
-
clone
Description copied from class:TLcdDataObject
Returns a deep clone of this object. If the clone is not already present in the dictionary, a new instance if created as follows:- First, a new instance is created using Java's clone() mechanism.
- Then, all properties of this object are cloned and set on the newly created
instance. A property is cloned as follows:
- If the property value is an
ILcdDataObject
, the value is cloned by first creating a new instance via thevalue.getDataType().newInstance()
method, and then cloning its properties one by one. - If the value implements
ILcdDeepCloneable
orILcdCloneable
then this interface is used to clone the value. - Otherwise, the property value is copied by reference.
- If the property value is an
- Specified by:
clone
in interfaceILcdDeepCloneable
- Overrides:
clone
in classTLcdGML32AbstractFeature
- Parameters:
aObjectDictionary
- the Object dictionary that keeps track of the objects for which a clone has already been made, and their corresponding clone Object.- Returns:
- a deep clone of this object
-
getBoundedBy
Returns the value of the property that maps to theboundedBy
element.This property describes the minimum bounding box or rectangle that encloses the entire feature.
- Returns:
- the value of the
BOUNDED_BY_PROPERTY
property.
-
setBoundedBy
Sets the value of the property that maps to theboundedBy
element.This property describes the minimum bounding box or rectangle that encloses the entire feature.
- Parameters:
aValue
- the value to set for theBOUNDED_BY_PROPERTY
property.
-
getLocation
Returns the value of the property that maps to thelocation
element.- Returns:
- the value of the
LOCATION_PROPERTY
property. - See Also:
-
setLocation
Sets the value of the property that maps to thelocation
element.- Parameters:
aValue
- the value to set for theLOCATION_PROPERTY
property.
-