Class TLcdKML22NetworkLink
- All Implemented Interfaces:
ILcdDataObject
,ILcdModel
,ILcdModelContainer
,ILcdModelProducerListener
,ILcdModelTreeNode
,ILcdBounded
,ILcdTimeBounded
,ILcdCache
,ILcdCloneable
,ILcdDeepCloneable
,ILcdDisposable
,Serializable
,AutoCloseable
,Cloneable
,ReadWriteLock
,EventListener
OGC KML Specification description:
This element can be used wherever the following element is referenced: -kml:AbstractFeatureGroup References a KML resource on a local or remote network. kml:NetworkLink elements may be used in combination with kml:Region elements to efficiently load and display large datasets.
- Since:
- 10.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 theAbstractFeatureObjectExtensionGroup
element.static final TLcdDataProperty
Data property that maps to theAbstractFeatureSimpleExtensionGroup
element.static final TLcdDataProperty
Data property that maps to theAbstractStyleSelectorGroup
element.static final TLcdDataProperty
Data property that maps to theAbstractTimePrimitiveGroup
element.static final TLcdDataProperty
Data property that maps to theAbstractViewGroup
element.static final TLcdDataProperty
Data property that maps to theAddressDetails
element.static final TLcdDataProperty
Data property that maps to theaddress
element.static final TLcdDataProperty
Data property that maps to thelink
element.static final TLcdDataProperty
Data property that maps to theauthor
element.static final TLcdDataProperty
Data property that maps to thedescription
element.static final TLcdDataProperty
Data property that maps to the choice between theMetadata
andExtendedData
elements.static final TLcdDataProperty
Data property that maps to theflyToView
element.static final TLcdDataProperty
Data property that maps to the choice between theUrl
andLink
elements.static final TLcdDataProperty
Data property that maps to thename
element.static final TLcdDataProperty
Data property that maps to theNetworkLinkObjectExtensionGroup
element.static final TLcdDataProperty
Data property that maps to theNetworkLinkSimpleExtensionGroup
element.static final TLcdDataProperty
Data property that maps to theopen
element.static final TLcdDataProperty
Data property that maps to thephoneNumber
element.static final TLcdDataProperty
Data property that maps to therefreshVisibility
element.static final TLcdDataProperty
Data property that maps to theRegion
element.static final TLcdDataProperty
Data property that maps to the choice between theSnippet
andsnippet
elements.static final TLcdDataProperty
Data property that maps to thestyleUrl
element.static final TLcdDataProperty
Data property that maps to thevisibility
element.Fields inherited from class com.luciad.format.kml22.model.TLcdKML22AbstractObject
ID_PROPERTY, OBJECT_SIMPLE_EXTENSION_GROUP_PROPERTY, TARGET_ID_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.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.void
dispose()
Disposes of this model and allows it to release any system resources that it is holding.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 theAbstractStyleSelectorGroup
element.Returns the value of the property that maps to theAbstractTimePrimitiveGroup
element.Returns the value of the property that maps to theAbstractViewGroup
element.Returns the value of the property that maps to theaddress
element.Returns the value of the property that maps to theAddressDetails
element.Returns the value of the property that maps to thelink
element.Returns the value of the property that maps to theauthor
element.Returns theILcdBounds
by which the geometry of thisILcdBounded
object is bounded.Returns the value of the property that maps to thedescription
element.Returns the value of the property that maps to the choice between theMetadata
andExtendedData
elements.Returns the value of the property that maps to theflyToView
element.getLink()
Returns the value of the property that maps to the choice between theUrl
andLink
elements.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.getName()
Returns the value of the property that maps to thename
element.getOpen()
Returns the value of the property that maps to theopen
element.Returns the value of the property that maps to thephoneNumber
element.Returns the value of the property that maps to therefreshVisibility
element.Returns the value of the property that maps to theRegion
element.Returns the value of the property that maps to the choice between theSnippet
andsnippet
elements.Returns the value of the property that maps to thestyleUrl
element.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
.readLock()
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
Sets the value of the property that maps to theAbstractTimePrimitiveGroup
element.void
Sets the value of the property that maps to theAbstractViewGroup
element.void
setAddress
(String aValue) Sets the value of the property that maps to theaddress
element.void
setAddressDetails
(ILcdDataObject aValue) Sets the value of the property that maps to theAddressDetails
element.void
setAtomLink
(ILcdDataObject aValue) Sets the value of the property that maps to thelink
element.void
setAuthor
(ILcdDataObject aValue) Sets the value of the property that maps to theauthor
element.void
setDescription
(String aValue) Sets the value of the property that maps to thedescription
element.void
setExtendedData
(ILcdDataObject aValue) Sets the value of the property that maps to the choice between theMetadata
andExtendedData
elements.void
setFlyToView
(Boolean aValue) Sets the value of the property that maps to theflyToView
element.void
setLink
(TLcdKML22Link aValue) Sets the value of the property that maps to the choice between theUrl
andLink
elements.void
Sets the value of the property that maps to thename
element.void
Sets the value of the property that maps to theopen
element.void
setPhoneNumber
(String aValue) Sets the value of the property that maps to thephoneNumber
element.void
setRefreshVisibility
(Boolean aValue) Sets the value of the property that maps to therefreshVisibility
element.void
setRegion
(TLcdKML22Region aValue) Sets the value of the property that maps to theRegion
element.void
setSnippet
(TLcdKML22Snippet aValue) Sets the value of the property that maps to the choice between theSnippet
andsnippet
elements.void
setStyleUrl
(String aValue) Sets the value of the property that maps to thestyleUrl
element.void
setVisibility
(Boolean aValue) Sets the value of the property that maps to thevisibility
element.Methods inherited from class com.luciad.format.kml22.model.feature.TLcdKML22AbstractFeature
clearCache, clone, getCachedObject, getInnerStyleSelector, getKMLSourceName, getTimeBounds, getVisibility, insertIntoCache, removeCachedObject, setKMLSourceName
Methods inherited from class com.luciad.format.kml22.model.TLcdKML22AbstractObject
getId, getTargetId, setId, setTargetId
Methods inherited from class com.luciad.datamodel.TLcdDataObject
clone, 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.util.ILcdDisposable
close
Methods inherited from interface com.luciad.model.ILcdModelContainer
getModels
-
Field Details
-
REFRESH_VISIBILITY_PROPERTY
Data property that maps to therefreshVisibility
element. The possible values for this property are instances ofBoolean
. -
FLY_TO_VIEW_PROPERTY
Data property that maps to theflyToView
element. The possible values for this property are instances ofBoolean
. -
LINK_PROPERTY
Data property that maps to the choice between theUrl
andLink
elements. The possible values for this property are instances of -
NETWORK_LINK_SIMPLE_EXTENSION_GROUP_PROPERTY
Data property that maps to theNetworkLinkSimpleExtensionGroup
element. The possible values for this property are instances ofList<String>
. -
NETWORK_LINK_OBJECT_EXTENSION_GROUP_PROPERTY
Data property that maps to theNetworkLinkObjectExtensionGroup
element. The possible values for this property are instances ofList<TLcdKML22AbstractObject>
. -
NAME_PROPERTY
Data property that maps to thename
element. The possible values for this property are instances ofString
. -
VISIBILITY_PROPERTY
Data property that maps to thevisibility
element. The possible values for this property are instances ofBoolean
. -
OPEN_PROPERTY
Data property that maps to theopen
element. The possible values for this property are instances ofBoolean
. -
AUTHOR_PROPERTY
Data property that maps to theauthor
element. The possible values for this property are instances ofILcdDataObject
. -
ATOM_LINK_PROPERTY
Data property that maps to thelink
element. The possible values for this property are instances ofILcdDataObject
. -
ADDRESS_PROPERTY
Data property that maps to theaddress
element. The possible values for this property are instances ofString
. -
ADDRESS_DETAILS_PROPERTY
Data property that maps to theAddressDetails
element. The possible values for this property are instances ofILcdDataObject
. -
PHONE_NUMBER_PROPERTY
Data property that maps to thephoneNumber
element. The possible values for this property are instances ofString
. -
SNIPPET_PROPERTY
Data property that maps to the choice between theSnippet
andsnippet
elements. The possible values for this property are instances ofTLcdKML22Snippet
String
-
DESCRIPTION_PROPERTY
Data property that maps to thedescription
element. The possible values for this property are instances ofString
. -
ABSTRACT_VIEW_GROUP_PROPERTY
Data property that maps to theAbstractViewGroup
element. The possible values for this property are instances ofTLcdKML22AbstractView
. -
ABSTRACT_TIME_PRIMITIVE_GROUP_PROPERTY
Data property that maps to theAbstractTimePrimitiveGroup
element. The possible values for this property are instances ofTLcdKML22AbstractTimePrimitive
. -
STYLE_URL_PROPERTY
Data property that maps to thestyleUrl
element. The possible values for this property are instances ofString
. -
ABSTRACT_STYLE_SELECTOR_GROUP_PROPERTY
Data property that maps to theAbstractStyleSelectorGroup
element. The possible values for this property are instances ofList<TLcdKML22AbstractStyleSelector>
. -
REGION_PROPERTY
Data property that maps to theRegion
element. The possible values for this property are instances ofTLcdKML22Region
. -
EXTENDED_DATA_PROPERTY
Data property that maps to the choice between theMetadata
andExtendedData
elements. The possible values for this property are instances of -
ABSTRACT_FEATURE_SIMPLE_EXTENSION_GROUP_PROPERTY
Data property that maps to theAbstractFeatureSimpleExtensionGroup
element. The possible values for this property are instances ofList<String>
. -
ABSTRACT_FEATURE_OBJECT_EXTENSION_GROUP_PROPERTY
Data property that maps to theAbstractFeatureObjectExtensionGroup
element. The possible values for this property are instances ofList<TLcdKML22AbstractObject>
.
-
-
Constructor Details
-
TLcdKML22NetworkLink
-
-
Method Details
-
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:
-
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.
-
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
-
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
.
-
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:
-
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
.
-
addModelListener
Description copied from interface:ILcdModelTreeNode
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.The model listener will not receive any notifications of model changes in any of the child models. If the listener should also receive notifications about changes in the child models, it should be registered as a hierarchy listener (see
ILcdModelTreeNode.addHierarchyModelListener(ILcdModelListener)
).- 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:ILcdModelTreeNode
Unregisters the specified model listener so that it no longer receives notifications of model changes on this model.It is not possible to unregister hierarchy model listeners with this method. Use
ILcdModelTreeNode.removeHierarchyModelListener(ILcdModelListener)
for this purpose.- 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:ILcdModelTreeNode
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.Calling this method will not dispose any of the child models, or alter the hierarchical structure. If the child models should also be disposed, this method should be called on those models.
- Specified by:
dispose
in interfaceILcdDisposable
- Specified by:
dispose
in interfaceILcdModel
- Specified by:
dispose
in interfaceILcdModelTreeNode
-
elements
Description copied from interface:ILcdModelTreeNode
Returns an enumeration over all elements of this model. The order in which the elements are enumerated is unspecified by default.The elements of the child model(s) are not included in this enumeration.
- Specified by:
elements
in interfaceILcdModel
- Specified by:
elements
in interfaceILcdModelTreeNode
- Returns:
- an enumeration over all elements of this model. The elements of the child model(s) are not included in this enumeration.
-
getModelDescriptor
Description copied from interface:ILcdModelTreeNode
Returns theILcdModelDescriptor
providing meta information about this model and its elements.This model descriptor is independent of the model descriptor(s) of the child models of this node.
- Specified by:
getModelDescriptor
in interfaceILcdModel
- Specified by:
getModelDescriptor
in interfaceILcdModelTreeNode
- Returns:
- the
ILcdModelDescriptor
of thisILcdModel
. Should not benull
.
-
getModelEncoder
Description copied from interface:ILcdModelTreeNode
Returns, if available, a model encoder that is capable of encoding this model, (encoder.canEncode(this)
),null
otherwise.It is implementation-dependant whether this encoder considers the child models or not.
- 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.
-
getModelReference
Description copied from interface:ILcdModelTreeNode
Returns theILcdModelReference
describing how the geometry of the elements contained in this model should be interpreted.This model reference is independent of the model reference(s) of the child models of this node.
- Specified by:
getModelReference
in interfaceILcdModel
- Specified by:
getModelReference
in interfaceILcdModelTreeNode
- Returns:
- the
ILcdModelReference
of thisILcdModel
.
-
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.
-
canAddElement
Description copied from interface:ILcdModelTreeNode
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.
This method only checks this model node and not any of the child models.
- 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.
-
addElement
Description copied from interface:ILcdModelTreeNode
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.The element will only be added to this model node and not to any of the child model(s).
- 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:
-
addElements
Description copied from interface:ILcdModelTreeNode
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.The elements will only be added to this model node and not to any of the child model(s).
- 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:
-
canRemoveElement
Description copied from interface:ILcdModelTreeNode
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.This method will only check this model node and not any of the child models.
- 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.
-
removeElement
Description copied from interface:ILcdModelTreeNode
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.The element will not be removed from the child model(s).
- 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:
-
removeElements
Description copied from interface:ILcdModelTreeNode
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.The elements will not be removed from the child model(s).
- 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:ILcdModelTreeNode
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.It will not remove any elements from any of the child models.
- 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:ILcdModelTreeNode
Notifies this model that the specified element has changed.When an element in one the child models has changed, this method must be called on that child model and not on this node.
- 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:ILcdModelTreeNode
Notifies this model that the elements in the specified vector have changed.When elements of one of the child models have changed, this method must be called on that child model and not on this node.
- 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:ILcdModelTreeNode
Notifies all listeners that are registered on this model of all the changes that have been collected between the previous notification and now.Notice that both the hierarchical as the regular registered model listeners will be notified.
Only the changes in this model node will be fired, not the changes in any of the child models.
- Specified by:
fireCollectedModelChanges
in interfaceILcdModel
- Specified by:
fireCollectedModelChanges
in interfaceILcdModelTreeNode
- See Also:
-
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
- Returns:
- the
ILcdBounds
by which the geometry of thisILcdBounded
object is bounded.
-
readLock
- Specified by:
readLock
in interfaceReadWriteLock
-
writeLock
- Specified by:
writeLock
in interfaceReadWriteLock
-
getRefreshVisibility
Returns the value of the property that maps to therefreshVisibility
element.- Returns:
- the value of the
REFRESH_VISIBILITY_PROPERTY
property.
-
setRefreshVisibility
Sets the value of the property that maps to therefreshVisibility
element.- Parameters:
aValue
- the value to set for theREFRESH_VISIBILITY_PROPERTY
property.
-
getFlyToView
Returns the value of the property that maps to theflyToView
element.- Returns:
- the value of the
FLY_TO_VIEW_PROPERTY
property.
-
setFlyToView
Sets the value of the property that maps to theflyToView
element.- Parameters:
aValue
- the value to set for theFLY_TO_VIEW_PROPERTY
property.
-
getLink
Returns the value of the property that maps to the choice between theUrl
andLink
elements.The possible values for this property are instances of
- Returns:
- the value of the
LINK_PROPERTY
property.
-
setLink
Sets the value of the property that maps to the choice between theUrl
andLink
elements.The possible values for this property are instances of
- Parameters:
aValue
- the value to set for theLINK_PROPERTY
property.
-
getName
Returns the value of the property that maps to thename
element.- Returns:
- the value of the
NAME_PROPERTY
property.
-
setName
Sets the value of the property that maps to thename
element.- Parameters:
aValue
- the value to set for theNAME_PROPERTY
property.
-
setVisibility
Sets the value of the property that maps to thevisibility
element.- Parameters:
aValue
- the value to set for theVISIBILITY_PROPERTY
property.
-
getOpen
Returns the value of the property that maps to theopen
element.- Returns:
- the value of the
OPEN_PROPERTY
property.
-
setOpen
Sets the value of the property that maps to theopen
element.- Parameters:
aValue
- the value to set for theOPEN_PROPERTY
property.
-
getAuthor
Returns the value of the property that maps to theauthor
element.- Returns:
- the value of the
AUTHOR_PROPERTY
property.
-
setAuthor
Sets the value of the property that maps to theauthor
element.- Parameters:
aValue
- the value to set for theAUTHOR_PROPERTY
property.
-
getAtomLink
Returns the value of the property that maps to thelink
element.- Returns:
- the value of the
ATOM_LINK_PROPERTY
property.
-
setAtomLink
Sets the value of the property that maps to thelink
element.- Parameters:
aValue
- the value to set for theATOM_LINK_PROPERTY
property.
-
getAddress
Returns the value of the property that maps to theaddress
element.- Returns:
- the value of the
ADDRESS_PROPERTY
property.
-
setAddress
Sets the value of the property that maps to theaddress
element.- Parameters:
aValue
- the value to set for theADDRESS_PROPERTY
property.
-
getAddressDetails
Returns the value of the property that maps to theAddressDetails
element.This container defines the details of the address. Can define multiple addresses including tracking address history
- Returns:
- the value of the
ADDRESS_DETAILS_PROPERTY
property.
-
setAddressDetails
Sets the value of the property that maps to theAddressDetails
element.This container defines the details of the address. Can define multiple addresses including tracking address history
- Parameters:
aValue
- the value to set for theADDRESS_DETAILS_PROPERTY
property.
-
getPhoneNumber
Returns the value of the property that maps to thephoneNumber
element.- Returns:
- the value of the
PHONE_NUMBER_PROPERTY
property.
-
setPhoneNumber
Sets the value of the property that maps to thephoneNumber
element.- Parameters:
aValue
- the value to set for thePHONE_NUMBER_PROPERTY
property.
-
getSnippet
Returns the value of the property that maps to the choice between theSnippet
andsnippet
elements.The possible values for this property are instances of
TLcdKML22Snippet
String
- Returns:
- the value of the
SNIPPET_PROPERTY
property.
-
setSnippet
Sets the value of the property that maps to the choice between theSnippet
andsnippet
elements.The possible values for this property are instances of
TLcdKML22Snippet
String
- Parameters:
aValue
- the value to set for theSNIPPET_PROPERTY
property.
-
getDescription
Returns the value of the property that maps to thedescription
element.- Returns:
- the value of the
DESCRIPTION_PROPERTY
property.
-
setDescription
Sets the value of the property that maps to thedescription
element.- Parameters:
aValue
- the value to set for theDESCRIPTION_PROPERTY
property.
-
getAbstractViewGroup
Returns the value of the property that maps to theAbstractViewGroup
element.- Returns:
- the value of the
ABSTRACT_VIEW_GROUP_PROPERTY
property.
-
setAbstractViewGroup
Sets the value of the property that maps to theAbstractViewGroup
element.- Parameters:
aValue
- the value to set for theABSTRACT_VIEW_GROUP_PROPERTY
property.
-
getAbstractTimePrimitiveGroup
Returns the value of the property that maps to theAbstractTimePrimitiveGroup
element.- Returns:
- the value of the
ABSTRACT_TIME_PRIMITIVE_GROUP_PROPERTY
property.
-
setAbstractTimePrimitiveGroup
Sets the value of the property that maps to theAbstractTimePrimitiveGroup
element.- Parameters:
aValue
- the value to set for theABSTRACT_TIME_PRIMITIVE_GROUP_PROPERTY
property.
-
getStyleUrl
Returns the value of the property that maps to thestyleUrl
element.- Returns:
- the value of the
STYLE_URL_PROPERTY
property.
-
setStyleUrl
Sets the value of the property that maps to thestyleUrl
element.- Parameters:
aValue
- the value to set for theSTYLE_URL_PROPERTY
property.
-
getAbstractStyleSelectorGroup
Returns the value of the property that maps to theAbstractStyleSelectorGroup
element.- Returns:
- the value of the
ABSTRACT_STYLE_SELECTOR_GROUP_PROPERTY
property.
-
getRegion
Returns the value of the property that maps to theRegion
element.- Returns:
- the value of the
REGION_PROPERTY
property.
-
setRegion
Sets the value of the property that maps to theRegion
element.- Parameters:
aValue
- the value to set for theREGION_PROPERTY
property.
-
getExtendedData
Returns the value of the property that maps to the choice between theMetadata
andExtendedData
elements.The possible values for this property are instances of
- Returns:
- the value of the
EXTENDED_DATA_PROPERTY
property.
-
setExtendedData
Sets the value of the property that maps to the choice between theMetadata
andExtendedData
elements.The possible values for this property are instances of
- Parameters:
aValue
- the value to set for theEXTENDED_DATA_PROPERTY
property.
-