Class TLcdGML31Model
- All Implemented Interfaces:
ILcdDataObject,ILcd2DBoundsIndexedModel,ILcd2DBoundsInteractable,ILcdIntegerIndexedModel,ILcdModel,ILcdModelContainer,ILcdModelProducerListener,ILcdModelTreeNode,ILcdBounded,ILcdShape,ILcdShapeList,ILcdLockDependent,ILcdCloneable,ILcdDeepCloneable,ILcdDisposable,ILcdFeatured,ILcdInvalidateable,ILcdSelfDescribedFeatured,Serializable,AutoCloseable,Cloneable,EventListener
TLcdGML31AbstractFeature-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
FieldsModifier and TypeFieldDescriptionstatic final TLcdDataPropertyData property that maps to theboundedByelement.static final TLcdDataPropertyData property that maps to thelocationelement.Fields inherited from class com.luciad.format.gml31.model.TLcdGML31AbstractGML
DESCRIPTION_PROPERTY, ID_PROPERTY, META_DATA_PROPERTY_PROPERTY, NAME_PROPERTYFields inherited from interface com.luciad.model.ILcdModel
FIRE_LATER, FIRE_NOW, NO_EVENT -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddElement(Object aElement, int aEventMode) Adds the specified element to this model.voidaddElements(Vector aElements, int aEventMode) Adds all of the elements in the specified vector to this model.voidaddHierarchyModelContainerListener(ILcdModelContainerListener aModelContainerListener) Registers the givenILcdModelContainerListenerto receiveTLcdModelContainerEvents from all theILcdModelTreeNodes contained in the tree with this node as root node.voidaddHierarchyModelListener(ILcdModelListener aModelListener) Registers the givenILcdModelListenerto receiveTLcdModelChangedEvents from all theILcdModels contained in the tree with this node as root node.booleanAdds theILcdModel aModelas a child model to thisILcdModelTreeNode.voidaddModelContainerListener(ILcdModelContainerListener aModelContainerListener) Adds anILcdModelContainerListenerto thisILcdModelContainer.voidaddModelListener(ILcdModelListener aModelListener) Registers the specified model listener to receive notifications of model changes on this model.intapplyOnInteract2DBounds(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.intapplyOnInteract2DBounds(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.booleancanAddElement(Object aElement) Returnstrueif the specified element can be added to this model,falseotherwise.booleancanRemoveElement(Object aElement) Returnstrueif the specified element can be removed from this model,falseotherwise.Returns a deep clone of this object.voiddispose()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.voidelementChanged(Object aElement, int aEventMode) Notifies this model that the specified element has changed.elements()Returns an enumeration over all elements of this model.voidelementsChanged(Vector aElements, int aEventMode) Notifies this model that the elements in the specified vector have changed.voidNotifies 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 theboundedByelement.Returns theILcdBoundsby which the geometry of thisILcdBoundedobject is bounded.Returns the objects that must be locked along with this object.Returns the value of the property that maps to thelocationelement.getModel(int aIndex) Returns the child model at the given index.Returns theILcdModelDescriptorproviding meta information about this model and its elements.Returns, if available, a model encoder that is capable of encoding this model, (encoder.canEncode(this)),nullotherwise.Collects and returns metadata about the model.Returns theILcdModelReferencedescribing how the geometry of the elements contained in this model should be interpreted.intReturns the index of the first occurrence of the specified element in the model, or -1 if this model does not contain the element.voidbooleanisEmpty()Returnstruewhen the model node is only used as a container for other models, and contains no useful data itself,falseotherwise.intReturns the number of child models of this model node.voidmodelProduced(TLcdModelProducerEvent aModelProducerEvent) Notifies this ILcdModelProducerListener of a produced model.models()Returns anEnumerationof the child models of thisILcdModelTreeNode.voidremoveAllElements(int aEventMode) Removes all elements from this model.voidremoveElement(Object aElement, int aEventMode) Removes the specified element from this model.voidremoveElements(Vector aElements, int aEventMode) Removes all of the elements in the specified vector from this model.voidremoveHierarchyModelContainerListener(ILcdModelContainerListener aModelContainerListener) Unregisters the givenILcdModelContainerListenerfrom receivingTLcdModelContainerEvents for the tree with this node as root node.voidremoveHierarchyModelListener(ILcdModelListener aModelListener) Unregisters the givenILcdModelListenerfrom receivingTLcdModelChangedEvents for the tree with this node as root node.booleanremoveModel(ILcdModel aModel) Removes the child modelaModelfrom thisILcdModelTreeNode.voidremoveModelContainerListener(ILcdModelContainerListener aModelContainerListener) Removes anILcdModelContainerListenerfrom thisILcdModelContainer.voidremoveModelListener(ILcdModelListener aModelListener) Unregisters the specified model listener so that it no longer receives notifications of model changes on this model.voidsetBoundedBy(TLcdGML31BoundingShape aValue) Sets the value of the property that maps to theboundedByelement.voidsetLocation(Object aValue) Sets the value of the property that maps to thelocationelement.voidsetModelDescriptor(TLcdGML31ModelDescriptor aModelDescriptor) voidsetModelReference(ILcdModelReference aModelReference) intsize()Returns the number of elements in this model.Methods inherited from class com.luciad.format.gml31.model.TLcdGML31AbstractFeature
clone, collectShapes, contains2D, contains2D, contains3D, contains3D, getFocusPoint, getShape, getShapeCount, invalidateObject, shapesChangedMethods inherited from class com.luciad.format.gml31.model.TLcdGML31AbstractGML
getDescription, getId, getMetaDataProperty, getName, setDescription, setIdMethods inherited from class com.luciad.datamodel.TLcdFeaturedDataObject
canSetFeature, getFeature, getFeature, getFeatureCount, getFeaturedDescriptor, setFeature, setFeatureMethods inherited from class com.luciad.datamodel.TLcdDataObject
getDataType, getValue, getValue, hasValue, hasValue, setValue, setValue, toStringMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.luciad.model.ILcd2DBoundsIndexedModel
queryMethods inherited from interface com.luciad.util.ILcdDisposable
closeMethods inherited from interface com.luciad.model.ILcdModelContainer
getModels
-
Field Details
-
BOUNDED_BY_PROPERTY
Data property that maps to theboundedByelement. The possible values for this property are instances ofTLcdGML31BoundingShape. -
LOCATION_PROPERTY
Data property that maps to thelocationelement. The possible values for this property are instances ofTLcdGML31LocationProperty.
-
-
Constructor Details
-
TLcdGML31Model
- Parameters:
aType- aTLcdGML31AbstractFeaturetype with a property of typeTLcdGML31DataTypes.FeaturePropertyType
-
-
Method Details
-
invalidateModel
public void invalidateModel() -
setModelReference
-
setModelDescriptor
-
addHierarchyModelContainerListener
Description copied from interface:ILcdModelTreeNodeRegisters the given
ILcdModelContainerListenerto receiveTLcdModelContainerEvents from all theILcdModelTreeNodes 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
ILcdModelContainerof the event can be retrieved by callingTLcdModelContainerEvent.getModelContainer()on the receivedTLcdModelContainerEvent.- Specified by:
addHierarchyModelContainerListenerin interfaceILcdModelTreeNode- Parameters:
aModelContainerListener- the listener- See Also:
-
addHierarchyModelListener
Description copied from interface:ILcdModelTreeNodeRegisters the given
ILcdModelListenerto receiveTLcdModelChangedEvents from all theILcdModels 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
ILcdModelof the event can be retrieved by callingTLcdModelChangedEvent.getModel()on the receivedTLcdModelChangedEvent.- Specified by:
addHierarchyModelListenerin interfaceILcdModelTreeNode- Parameters:
aModelListener- the listener- See Also:
-
removeHierarchyModelContainerListener
public void removeHierarchyModelContainerListener(ILcdModelContainerListener aModelContainerListener) Description copied from interface:ILcdModelTreeNodeUnregisters the given
ILcdModelContainerListenerfrom receivingTLcdModelContainerEvents for the tree with this node as root node.- Specified by:
removeHierarchyModelContainerListenerin interfaceILcdModelTreeNode- Parameters:
aModelContainerListener- the listener- See Also:
-
removeHierarchyModelListener
Description copied from interface:ILcdModelTreeNodeUnregisters the given
ILcdModelListenerfrom receivingTLcdModelChangedEvents for the tree with this node as root node.- Specified by:
removeHierarchyModelListenerin interfaceILcdModelTreeNode- Parameters:
aModelListener- the listener- See Also:
-
addModel
Description copied from interface:ILcdModelTreeNodeAdds the
ILcdModel aModelas a child model to thisILcdModelTreeNode.- Specified by:
addModelin interfaceILcdModelContainer- Specified by:
addModelin interfaceILcdModelTreeNode- Parameters:
aModel- the model to be added.- Returns:
trueif this collection of models changed as a result of the call
-
addModelContainerListener
Description copied from interface:ILcdModelTreeNodeAdds anILcdModelContainerListenerto thisILcdModelContainer.It will only receive notifications of changes in this
.ILcdModelTreeNodeand 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:
addModelContainerListenerin interfaceILcdModelContainer- Specified by:
addModelContainerListenerin interfaceILcdModelTreeNode- Parameters:
aModelContainerListener- the listener to be added.- See Also:
-
getModel
Description copied from interface:ILcdModelTreeNodeReturns the child model at the given index.
- Specified by:
getModelin interfaceILcdModelContainer- Specified by:
getModelin interfaceILcdModelTreeNode- Parameters:
aIndex- a valid index in thisILcdModelTreeNode- Returns:
- the child model at the given index.
-
modelCount
public int modelCount()Description copied from interface:ILcdModelTreeNodeReturns the number of child models of this model node.
- Specified by:
modelCountin interfaceILcdModelContainer- Specified by:
modelCountin interfaceILcdModelTreeNode- Returns:
- the number of child models of this model node.
-
models
Description copied from interface:ILcdModelTreeNodeReturns an
Enumerationof the child models of thisILcdModelTreeNode.- Specified by:
modelsin interfaceILcdModelContainer- Specified by:
modelsin interfaceILcdModelTreeNode- Returns:
- an
Enumerationof the child models of thisILcdModelTreeNode.
-
removeModel
Description copied from interface:ILcdModelTreeNodeRemoves the child model
aModelfrom thisILcdModelTreeNode.- Specified by:
removeModelin interfaceILcdModelContainer- Specified by:
removeModelin interfaceILcdModelTreeNode- Parameters:
aModel- the model to be removed.- Returns:
trueif a model was removed as a result of this call
-
removeModelContainerListener
Description copied from interface:ILcdModelTreeNodeRemoves anILcdModelContainerListenerfrom thisILcdModelContainer.It is not possible to remove a hierarchy model container listener. Use
ILcdModelTreeNode.removeHierarchyModelContainerListener(ILcdModelContainerListener)for this purpose.- Specified by:
removeModelContainerListenerin interfaceILcdModelContainer- Specified by:
removeModelContainerListenerin interfaceILcdModelTreeNode- Parameters:
aModelContainerListener- the listener to be removed.- See Also:
-
modelProduced
Description copied from interface:ILcdModelProducerListenerNotifies this ILcdModelProducerListener of a produced model.- Specified by:
modelProducedin interfaceILcdModelProducerListener- Parameters:
aModelProducerEvent- the event describing the changes to aILcdModelProducer.
-
isEmpty
public boolean isEmpty()Description copied from interface:ILcdModelTreeNodeReturns
truewhen the model node is only used as a container for other models, and contains no useful data itself,falseotherwise.- Specified by:
isEmptyin interfaceILcdModelTreeNode- Returns:
truewhen the model node contains no useful data,falseotherwise
-
applyOnInteract2DBounds
public int applyOnInteract2DBounds(ILcdBounds aBounds, boolean aStrictOverlap, ILcdFunction aFunctionToApply, double aPrecisionX, double aPrecisionY) Description copied from interface:ILcd2DBoundsIndexedModelApplies 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:
applyOnInteract2DBoundsin 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
ILcdFunctionhas 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:ILcd2DBoundsInteractableApplies 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 returnsfalsefor an element it was applied on.- Specified by:
applyOnInteract2DBoundsin interfaceILcd2DBoundsIndexedModel- Specified by:
applyOnInteract2DBoundsin 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
ILcdFunctionhas been applied.
-
elementAt
Description copied from interface:ILcdIntegerIndexedModelReturns the element at the specified index.- Specified by:
elementAtin interfaceILcdIntegerIndexedModel- Parameters:
aIndex- an index into thisILcdModel.- Returns:
- the element at the specified index.
-
size
public int size()Description copied from interface:ILcdIntegerIndexedModelReturns the number of elements in this model.- Specified by:
sizein interfaceILcdIntegerIndexedModel- Returns:
- the number of elements in this model.
-
indexOf
Description copied from interface:ILcdIntegerIndexedModelReturns 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 smallestifor whichthis.elementAt(i).equals(aElement).- Specified by:
indexOfin 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:ILcdBoundedReturns theILcdBoundsby which the geometry of thisILcdBoundedobject 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
undefinedbounds. You can create undefined bounds using the default constructors ofTLcdLonLatBoundsorTLcdXYBounds.- Specified by:
getBoundsin interfaceILcdBounded- Overrides:
getBoundsin classTLcdGML31AbstractFeature- Returns:
- the
ILcdBoundsby which the geometry of thisILcdBoundedobject is bounded.
-
getModelReference
Description copied from interface:ILcdModelReturns theILcdModelReferencedescribing how the geometry of the elements contained in this model should be interpreted.- Specified by:
getModelReferencein interfaceILcdModel- Specified by:
getModelReferencein interfaceILcdModelTreeNode- Returns:
- the
ILcdModelReferenceof thisILcdModel.
-
getModelDescriptor
Description copied from interface:ILcdModelReturns theILcdModelDescriptorproviding meta information about this model and its elements.- Specified by:
getModelDescriptorin interfaceILcdModel- Specified by:
getModelDescriptorin interfaceILcdModelTreeNode- Returns:
- the
ILcdModelDescriptorof thisILcdModel. Should not benull.
-
getModelEncoder
Description copied from interface:ILcdModelReturns, if available, a model encoder that is capable of encoding this model, (encoder.canEncode(this)),nullotherwise.- Specified by:
getModelEncoderin interfaceILcdModel- Specified by:
getModelEncoderin interfaceILcdModelTreeNode- Returns:
- a model encoder that is capable of encoding this model if available,
nullotherwise.
-
getModelMetadata
Description copied from interface:ILcdModelCollects and returns metadata about the model. Note that this method does not necessarily return the sameTLcdModelMetadatainstance every time it is called. The default implementation usesTLcdModelMetadata.Builder.fromModel(com.luciad.model.ILcdModel).Implementations can
recreateorextendthe 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:
getModelMetadatain interfaceILcdModel- Returns:
- Metadata about the model.
-
elements
Description copied from interface:ILcdModelReturns an enumeration over all elements of this model. The order in which the elements are enumerated is unspecified by default.- Specified by:
elementsin interfaceILcdModel- Specified by:
elementsin interfaceILcdModelTreeNode- Returns:
- an enumeration over all elements of this model.
-
addElement
Description copied from interface:ILcdModelAdds 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:
addElementin interfaceILcdModel- Specified by:
addElementin interfaceILcdModelTreeNode- Parameters:
aElement- the element to be added to this model.aEventMode- the mode for sending out the model change event. This can beFIRE_LATERorNO_EVENT.- See Also:
-
canAddElement
Description copied from interface:ILcdModelReturnstrueif the specified element can be added to this model,falseotherwise.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:
canAddElementin interfaceILcdModel- Specified by:
canAddElementin interfaceILcdModelTreeNode- Parameters:
aElement- the element to be verified.- Returns:
trueif the specified element can be added to this model,falseotherwise.
-
addElements
Description copied from interface:ILcdModelAdds 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:
addElementsin interfaceILcdModel- Specified by:
addElementsin 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_LATERorNO_EVENT.- See Also:
-
removeElement
Description copied from interface:ILcdModelRemoves 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:
removeElementin interfaceILcdModel- Specified by:
removeElementin interfaceILcdModelTreeNode- Parameters:
aElement- the element to be removed from this model.aEventMode- the mode for sending out the model change event. This can beFIRE_LATERorNO_EVENT.- See Also:
-
canRemoveElement
Description copied from interface:ILcdModelReturnstrueif the specified element can be removed from this model,falseotherwise. Note that this method generally does not check whether the specified element is actually contained in this model.- Specified by:
canRemoveElementin interfaceILcdModel- Specified by:
canRemoveElementin interfaceILcdModelTreeNode- Parameters:
aElement- the element to be verified.- Returns:
trueif the specified element can be removed from this model,falseotherwise.
-
removeElements
Description copied from interface:ILcdModelRemoves 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:
removeElementsin interfaceILcdModel- Specified by:
removeElementsin 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_LATERorNO_EVENT.- See Also:
-
removeAllElements
public void removeAllElements(int aEventMode) Description copied from interface:ILcdModelRemoves 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:
removeAllElementsin interfaceILcdModel- Specified by:
removeAllElementsin interfaceILcdModelTreeNode- Parameters:
aEventMode- the mode for sending out the model change event. This can beFIRE_LATERorNO_EVENT.
-
elementChanged
Description copied from interface:ILcdModelNotifies this model that the specified element has changed.- Specified by:
elementChangedin interfaceILcdModel- Specified by:
elementChangedin interfaceILcdModelTreeNode- Parameters:
aElement- the element that has changed.aEventMode- the mode for sending out the model change event. This can beFIRE_LATERorNO_EVENT.
-
elementsChanged
Description copied from interface:ILcdModelNotifies this model that the elements in the specified vector have changed.- Specified by:
elementsChangedin interfaceILcdModel- Specified by:
elementsChangedin interfaceILcdModelTreeNode- Parameters:
aElements- the vector of elements that have changed.aEventMode- the mode for sending out the model change event. This can beFIRE_LATERorNO_EVENT.
-
fireCollectedModelChanges
public void fireCollectedModelChanges()Description copied from interface:ILcdModelNotifies all listeners that are registered on this model of all the changes that have been collected between the previous notification and now.- Specified by:
fireCollectedModelChangesin interfaceILcdModel- Specified by:
fireCollectedModelChangesin interfaceILcdModelTreeNode- See Also:
-
addModelListener
Description copied from interface:ILcdModelRegisters 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
ILcdFireEventModethat 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
ALcdWeakModelListenerinstance as model listener.- Specified by:
addModelListenerin interfaceILcdModel- Specified by:
addModelListenerin interfaceILcdModelTreeNode- Parameters:
aModelListener- theILcdModelListenerto register on this model.- See Also:
-
removeModelListener
Description copied from interface:ILcdModelUnregisters the specified model listener so that it no longer receives notifications of model changes on this model.- Specified by:
removeModelListenerin interfaceILcdModel- Specified by:
removeModelListenerin interfaceILcdModelTreeNode- Parameters:
aModelListener- theILcdModelListenerto remove.- See Also:
-
dispose
public void dispose()Description copied from interface:ILcdModelDisposes 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:
disposein interfaceILcdDisposable- Specified by:
disposein interfaceILcdModel- Specified by:
disposein interfaceILcdModelTreeNode
-
getDependentObjects
Description copied from interface:ILcdLockDependentReturns the objects that must be locked along with this object.TLcdLockUtilfirst locks all objects returned by this method before locking this object.- Specified by:
getDependentObjectsin interfaceILcdLockDependent- Returns:
- the objects that must be locked along with this object.
-
clone
Description copied from class:TLcdDataObjectReturns 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
ILcdDeepCloneableorILcdCloneablethen this interface is used to clone the value. - Otherwise, the property value is copied by reference.
- If the property value is an
- Specified by:
clonein interfaceILcdDeepCloneable- Overrides:
clonein classTLcdGML31AbstractFeature- 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 theboundedByelement.- Returns:
- the value of the
BOUNDED_BY_PROPERTYproperty.
-
setBoundedBy
Sets the value of the property that maps to theboundedByelement.- Parameters:
aValue- the value to set for theBOUNDED_BY_PROPERTYproperty.
-
getLocation
Returns the value of the property that maps to thelocationelement.Deprecated in GML 3.1.0
- Returns:
- the value of the
LOCATION_PROPERTYproperty. - See Also:
-
setLocation
Sets the value of the property that maps to thelocationelement.Deprecated in GML 3.1.0
- Parameters:
aValue- the value to set for theLOCATION_PROPERTYproperty.
-