public class TLcdKML22DynamicModel extends ALcdModel implements ILcdModelTreeNode, ILcd2DBoundsIndexedModel, ReadWriteLock, ILcdStatusSource
TLcdKML22Kml, TLcdKML22Document, TLcdKML22Folder,
TLcdKML22NetworkLink
), resolving the dynamic contents of KML data. If the wrapped model
contains network links, the links will be automatically resolved by this model, and the contents
of the resolved links will become available as submodels (also TLcdKML22DynamicModel
's)
of this model.
Since a network link can contain map-based parameters (e.g. the bounding
box of the map), a TLcdKML22DynamicModel
is typically created for each (map, kml model)
pair. These parameters are passed to this model through a TLcdKML22Parameters
.
The moment at which a network link is resolved, depends on the refresh mode and view refresh mode that is specified within the link:
elements()
. Note that the loading takes place asynchronously.TLcdKML22Parameters
no longer changes. Since a TLcdKML22Parameters
object is typically
updated by the view, this corresponds to the view stopping panning/zooming. If a delay is
specified, this will be taken into account. All
resources needed by this model are retrieved from the TLcdKML22ResourceProvider
that is
passed to this model.
In addition to network link resolving, this model also provides functionality for advanced filtering, based on:
Note: To
ensure that TLcdKML22DynamicModel
does no longer than necessary perform network link
updates, it is advised to call the dispose()
method as soon as the model is removed from
the view (and no longer used elsewhere). If dispose
is not called, the model will keep
updating itself until it is garbage collected.
ILcdModel.Query
fModelEventSupport
FIRE_LATER, FIRE_NOW, NO_EVENT
Constructor and Description |
---|
TLcdKML22DynamicModel(TLcdKML22Kml aKml,
TLcdKML22ResourceProvider aResourceProvider,
TLcdKML22Parameters aParameters,
ILcdKML22RegionFilter aRegionFilter) |
Modifier and Type | Method and Description |
---|---|
void |
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 given
ILcdModelContainerListener to receive TLcdModelContainerEvent s from all the
ILcdModelTreeNode s contained in the tree with this node as root node. |
void |
addHierarchyModelListener(ILcdModelListener aModelListener)
Registers the given
ILcdModelListener to receive
TLcdModelChangedEvent s from all the ILcdModel s contained in the tree
with this node as root node. |
boolean |
addModel(ILcdModel aModel)
Adds the
ILcdModel aModel as a child model to this
ILcdModelTreeNode . |
void |
addModelContainerListener(ILcdModelContainerListener aModelContainerListener)
Adds an
ILcdModelContainerListener to this ILcdModelContainer . |
void |
addModelListener(ILcdModelListener aModelListener)
Registers the specified model listener to receive notifications of model changes on this model.
|
void |
addStatusListener(ILcdStatusListener aStatusListener)
Adds a status listener to this model.
|
int |
applyOnInteract2DBounds(ILcdBounds aBounds,
boolean aStrictInteract,
ILcdFunction aFunctionToApply,
double aPrecisionX,
double aPrecisionY)
Calls the custom
applyOnInteract2DBounds method, with the following default
parameters: |
int |
applyOnInteract2DBounds(ILcdBounds aBounds,
boolean aStrictInteract,
ILcdFunction aFunctionToApply,
double aPrecisionX,
double aPrecisionY,
double aMinSizeX,
double aMinSizeY,
boolean aIncludePoints)
Calls the custom
applyOnInteract2DBounds method, with the following default
parameters: |
int |
applyOnInteract2DBounds(ILcdBounds aBounds,
ILcdTimeBounds aTimeBounds,
Set<ELcdKML22ContentType> aContentTypes,
Set<ELcdKML22AltitudeMode> aFilterOnAltitudeModes,
boolean aFilterOnVisibility,
boolean aFilterOnRegion,
boolean aForceDrawingOrder,
boolean aStrictInteract,
ILcdFunction aFunctionToApply,
double aPrecisionX,
double aPrecisionY)
Applies the specified function to all the model elements that meet the specified filter.
|
int |
applyOnInteract2DBounds(ILcdBounds aBounds,
ILcdTimeBounds aTimeBounds,
Set<ELcdKML22ContentType> aContentTypes,
Set<ELcdKML22AltitudeMode> aFilterOnAltitudeModes,
boolean aFilterOnVisibility,
boolean aFilterOnRegion,
boolean aForceDrawingOrder,
boolean aStrictInteract,
ILcdFunction aFunctionToApply,
double aPrecisionX,
double aPrecisionY,
double aMinSizeX,
double aMinSizeY,
boolean aIncludePoints)
Applies the specified function to all the model elements that meet the specified filter.
|
boolean |
canAddElement(Object aElement)
Returns
true if the specified element can be added to this model, false otherwise. |
boolean |
canRemoveElement(Object aElement)
Returns
true 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.
|
Enumeration |
elements()
Returns an enumeration over all elements of this model.
|
Enumeration |
elements(ILcdBounds aBounds,
ILcdTimeBounds aTimeBounds,
Set<ELcdKML22ContentType> aContentTypes,
Set<ELcdKML22AltitudeMode> aAltitudeModes,
boolean aFilterOnVisibility,
boolean aFilterOnRegion,
boolean aForceDrawingOrder)
Returns an enumeration over all elements of this model that meet the specified filter.
|
void |
elementsChanged(Vector aElements,
int aEventMode)
Notifies this model that the elements in the specified vector have changed.
|
void |
fireCollectedModelChanges()
Notifies all listeners that are registered on this model of all the changes that have been collected between the
previous notification and now.
|
ILcdBounds |
getBounds()
Returns the
ILcdBounds by which the geometry of this ILcdBounded object
is bounded. |
ILcdBounds |
getBounds(ILcdTimeBounds aTimeBounds,
Set<ELcdKML22ContentType> aContentTypes,
Set<ELcdKML22AltitudeMode> aAltitudeModes,
boolean aFilterOnVisibility,
ILcdFilter aElementFilter)
Returns the union of all spatial bounds of the elements in this model that meet the specified
filter.
|
ILcdModelTreeNode |
getKMLModel()
Returns the static KML model that is wrapped by this model.
|
TLcdKML22NetworkLink |
getKMLNetworkLink()
Returns the networklink contained by this dynamic model, if any.
|
TLcdKML22Parameters |
getKMLParameters()
Returns the KML parameters this dynamic model uses
|
TLcdKML22DynamicModel |
getModel(int aIndex)
Returns the child model at the given index.
|
ILcdModelDescriptor |
getModelDescriptor()
Returns the
ILcdModelDescriptor providing meta information about this model and
its elements. |
ILcdModelEncoder |
getModelEncoder()
Returns, if available, a model encoder that is capable of encoding this model,
(
encoder.canEncode(this) ), null otherwise. |
ILcdModelReference |
getModelReference()
Returns the
ILcdModelReference describing how the geometry of the elements contained in this
model should be interpreted. |
String |
getName()
Returns a string representation of this dynamic model, depending on the wrapped KML feature.
|
ILcdKML22RegionFilter |
getRegionFilter()
Returns the region filter this dynamic model uses
|
ELcdKML22ResourceStatus |
getStatus()
Returns the status of this model.
|
ILcdTimeBounds |
getTimeBounds(ILcdBounds aSpatialBounds,
Set<ELcdKML22ContentType> aContentTypes,
Set<ELcdKML22AltitudeMode> aAltitudeModes,
boolean aFilterOnVisibility,
boolean aFilterOnRegion,
ILcdFilter aElementFilter,
boolean aIgnoreUnboundedTimeBounds)
Returns the union of all time bounds of the elements in this model that meet the specified
filter.
|
boolean |
isEmpty()
Returns
true when the model node is only used as a container for other models,
and contains no useful data itself, false otherwise. |
int |
modelCount()
Returns the number of child models of this model node.
|
void |
modelProduced(TLcdModelProducerEvent aModelProducerEvent)
Notifies this ILcdModelProducerListener of a produced model.
|
Enumeration |
models()
Returns an
Enumeration of the child models of this
ILcdModelTreeNode . |
Lock |
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 given
ILcdModelContainerListener from receiving TLcdModelContainerEvent s for the tree
with this node as root node. |
void |
removeHierarchyModelListener(ILcdModelListener aModelListener)
Unregisters the given
ILcdModelListener from
receiving TLcdModelChangedEvent s for the tree with this node as root node. |
boolean |
removeModel(ILcdModel aModel)
Removes the child model
aModel from this ILcdModelTreeNode . |
void |
removeModelContainerListener(ILcdModelContainerListener aModelContainerListener)
Removes an
ILcdModelContainerListener from this ILcdModelContainer . |
void |
removeModelListener(ILcdModelListener aModelListener)
Unregisters the specified model listener so that it no longer receives notifications of model changes on this model.
|
void |
removeStatusListener(ILcdStatusListener aStatusListener)
Removes the specified status listener from this model.
|
void |
setHierarchicalVisibility(boolean aVisibility)
Sets the visibility of the kml entity contained by this
TLcdKML22DynamicModel in a
hierarchical fashion. |
void |
setKMLParameters(TLcdKML22Parameters aParameterProvider)
Sets the KML parameters for this dynamic model, and all underlying child dynamic models.
|
void |
setRegionFilter(ILcdKML22RegionFilter aRegionFilter)
Sets the region filter for this dynamic model, and all underlying child dynamic models.
|
void |
updateNetworkLink()
Updates the NetworkLink of this TLcdKML22DynamicModel (if any).
|
Lock |
writeLock() |
allElementsChanged, allElementsRemoved, elementAdded, elementRemoved, elementsAdded, elementsRemoved, getModelMetadata, initializeTransientValues, isClassTraceOn, isTraceOn, setClassTraceOn, setModelDescriptor, setModelDisposer, setModelEncoder, setModelMetadataFunction, setModelReference, setTraceOn
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getModels
query
all, filter, getModelMetadata
close
public TLcdKML22DynamicModel(TLcdKML22Kml aKml, TLcdKML22ResourceProvider aResourceProvider, TLcdKML22Parameters aParameters, ILcdKML22RegionFilter aRegionFilter)
public ILcdModelTreeNode getKMLModel()
Returns the static KML model that is wrapped by this model. This is either a TLcdKML22Kml or TLcdKML22AbstractContainer otherwise.
public TLcdKML22NetworkLink getKMLNetworkLink()
Returns the networklink contained by this dynamic model, if any.
TLcdKML22NetworkLink
if this TLcdKML22DynamicModel
was wraps a
TLcdKML22NetworkLink
; null otherwise.public void setRegionFilter(ILcdKML22RegionFilter aRegionFilter)
Sets the region filter for this dynamic model, and all underlying child dynamic models.
This method also fires a property change event
aRegionFilter
- a region filter to set on this dynamic model and all its children
recursivelypublic ILcdKML22RegionFilter getRegionFilter()
public void setKMLParameters(TLcdKML22Parameters aParameterProvider)
Sets the KML parameters for this dynamic model, and all underlying child dynamic models.
This method also fires a property change event
aParameterProvider
- a KML parameters to set on this dynamic model and all its children
recursivelypublic TLcdKML22Parameters getKMLParameters()
public void setHierarchicalVisibility(boolean aVisibility)
Sets the visibility of the kml entity contained by this TLcdKML22DynamicModel
in a
hierarchical fashion.
It does the following things:
TLcdKML22DynamicModel
is set to the given visibilityTLcdKML22DynamicModel
instances contained by this TLcdKML22DynamicModel
TLcdKML22DynamicModel
, as well as the
elements of all child modelsIf the recursion is unwanted, you can use the getKMLNetworkLink()
method to
retrieve the underlying KML entity, and change the visibility of that element manually using
ALcdKML22AbstractFeature.setVisibility(Boolean)
. This way, no other elements will have
their elements changed, and no events will be fired.
aVisibility
- the visibility to set in a hierarchical fashionpublic String getName()
public void addStatusListener(ILcdStatusListener aStatusListener)
addStatusListener
in interface ILcdStatusSource
aStatusListener
- a listener to be notified of network link changes in this model.removeStatusListener(com.luciad.util.ILcdStatusListener)
public void removeStatusListener(ILcdStatusListener aStatusListener)
removeStatusListener
in interface ILcdStatusSource
aStatusListener
- a status listener to be removed from this model.addStatusListener(com.luciad.util.ILcdStatusListener)
public ELcdKML22ResourceStatus getStatus()
public int applyOnInteract2DBounds(ILcdBounds aBounds, ILcdTimeBounds aTimeBounds, Set<ELcdKML22ContentType> aContentTypes, Set<ELcdKML22AltitudeMode> aFilterOnAltitudeModes, boolean aFilterOnVisibility, boolean aFilterOnRegion, boolean aForceDrawingOrder, boolean aStrictInteract, ILcdFunction aFunctionToApply, double aPrecisionX, double aPrecisionY)
false
.aBounds
- the spatial bounds filter - only overlapping elements will be
selected.aTimeBounds
- the time bounds filter - only overlapping elements will be
selected.aContentTypes
- the KML content type filter - only elements with the specified
content type will be selected.aFilterOnAltitudeModes
- the altitude mode filter - only elements with the specified
altitude mode will be selected.aFilterOnVisibility
- the visibility filter - if true, only the visible element will be
selected, otherwise visibility will not be taken into account.aFilterOnRegion
- the region filter - if true only region active elements will be
selected, otherwise region activity will not be taken into
account.aForceDrawingOrder
- indicates whether the drawing order of overlays should be taken
into account. If true
, objects with a drawing order will
be applied after all other objects, and objects with a higher
drawing order will be applied after objects with a lower drawing
order.aStrictInteract
- if false
, the spatial search may return more elements
than the ones strictly overlapping; if true
, 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.aPrecisionY
- the precision required in the y dimension, expressed in
model units.ILcdFunction
has been applied.NullPointerException
- if the specified bounds or the specified function are null
.public int applyOnInteract2DBounds(ILcdBounds aBounds, ILcdTimeBounds aTimeBounds, Set<ELcdKML22ContentType> aContentTypes, Set<ELcdKML22AltitudeMode> aFilterOnAltitudeModes, boolean aFilterOnVisibility, boolean aFilterOnRegion, boolean aForceDrawingOrder, boolean aStrictInteract, ILcdFunction aFunctionToApply, double aPrecisionX, double aPrecisionY, double aMinSizeX, double aMinSizeY, boolean aIncludePoints)
false
for an element it was applied
on.aBounds
- the spatial bounds filter - only overlapping elements will be
selected.aTimeBounds
- the time bounds filter - only overlapping elements will be
selected.aContentTypes
- the KML content type filter - only elements with the specified
content type will be selected.aFilterOnAltitudeModes
- the altitude mode filter - only elements with the specified
altitude mode will be selected.aFilterOnVisibility
- the visibility filter - if true, only the visible element will be
selected, otherwise visibility will not be taken into account.aFilterOnRegion
- the region filter - if true only region active elements will be
selected, otherwise region activity will not be taken into
account.aForceDrawingOrder
- indicates whether the drawing order of overlays should be taken
into account. If true
, objects with a drawing order will
be applied after all other objects, and objects with a higher
drawing order will be applied after objects with a lower drawing
order.aStrictInteract
- if false
, the spatial search may return more elements
than the ones strictly overlapping; if true
, 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.aPrecisionY
- the precision required in the y dimension, expressed in
model units.aMinSizeX
- the minimal element size in the x dimension, expressed in
model units.aMinSizeY
- the minimal element size in the y dimension, expressed in
model units.aIncludePoints
- if true
, zero-sized elements (points) are considered as
well, even though they might be smaller than the minimum size.ILcdFunction
has been applied.NullPointerException
- if the specified bounds or the specified function are null
.public Enumeration elements(ILcdBounds aBounds, ILcdTimeBounds aTimeBounds, Set<ELcdKML22ContentType> aContentTypes, Set<ELcdKML22AltitudeMode> aAltitudeModes, boolean aFilterOnVisibility, boolean aFilterOnRegion, boolean aForceDrawingOrder)
aBounds
- the spatial bounds filter - only overlapping elements will be
selected.aTimeBounds
- the time bounds filter - only overlapping elements will be
selected.aContentTypes
- the KML content type filter - only elements with the specified
content type will be selected.aAltitudeModes
- the altitude mode filter - only elements with the specified altitude
mode will be selected.aFilterOnVisibility
- the visibility filter - if true
, only the visible element
will be selected, otherwise visibility will not be taken into
account.aFilterOnRegion
- region filter - if true
, elements in a non-active region
filter will be skipped.aForceDrawingOrder
- if true, the all elements that feature a draw order will be sorted
on their draw order.public ILcdBounds getBounds(ILcdTimeBounds aTimeBounds, Set<ELcdKML22ContentType> aContentTypes, Set<ELcdKML22AltitudeMode> aAltitudeModes, boolean aFilterOnVisibility, ILcdFilter aElementFilter)
aTimeBounds
- the time bounds filter - only overlapping elements will be
selected.aContentTypes
- the KML content type filter - only elements with the specified
content type will be selected.aAltitudeModes
- the altitude mode filter - only elements with the specified altitude
mode will be selected.aFilterOnVisibility
- the visibility filter - if true, only the visible element will be
selected, otherwise visibility will not be taken into account.aElementFilter
- a custom element filter to filter out certain elements from the
bounds calculationpublic ILcdTimeBounds getTimeBounds(ILcdBounds aSpatialBounds, Set<ELcdKML22ContentType> aContentTypes, Set<ELcdKML22AltitudeMode> aAltitudeModes, boolean aFilterOnVisibility, boolean aFilterOnRegion, ILcdFilter aElementFilter, boolean aIgnoreUnboundedTimeBounds)
aSpatialBounds
- the spatial bounds filter - only overlapping elements will be
selected.aContentTypes
- the KML content type filter - only elements with the
specified content type will be selected.aAltitudeModes
- the altitude mode filter - only elements with the specified
altitude mode will be selected.aFilterOnVisibility
- the visibility filter - if true, only the visible element
will be selected, otherwise visibility will not be taken into
account.aFilterOnRegion
- region filter - if true
, elements in a non-active
region filter will not be taken into account.aElementFilter
- A custom filter that will be applied on each element.aIgnoreUnboundedTimeBounds
- specifies whether unbounded start or end bounds should be
included in the union (if at least one element is unbounded,
the union bounds will be unbounded).public ILcdModelDescriptor getModelDescriptor()
ALcdModel
ILcdModelDescriptor
providing meta information about this model and
its elements.getModelDescriptor
in interface ILcdModel
getModelDescriptor
in interface ILcdModelTreeNode
getModelDescriptor
in class ALcdModel
ILcdModelDescriptor
of this ILcdModel
. Should not be null
.ALcdModel.setModelDescriptor(ILcdModelDescriptor)
public ILcdModelReference getModelReference()
ALcdModel
ILcdModelReference
describing how the geometry of the elements contained in this
model should be interpreted.getModelReference
in interface ILcdModel
getModelReference
in interface ILcdModelTreeNode
getModelReference
in class ALcdModel
ILcdModelReference
of this ILcdModel
.ALcdModel.setModelReference(ILcdModelReference)
public ILcdModelEncoder getModelEncoder()
ALcdModel
encoder.canEncode(this)
), null
otherwise.getModelEncoder
in interface ILcdModel
getModelEncoder
in interface ILcdModelTreeNode
getModelEncoder
in class ALcdModel
null
otherwise.ALcdModel.setModelEncoder(ILcdModelEncoder)
public Enumeration elements()
ILcdModelTreeNode
The elements of the child model(s) are not included in this enumeration.
elements
in interface ILcdModel
elements
in interface ILcdModelTreeNode
public boolean canAddElement(Object aElement)
ALcdModel
true
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 implementation always returns false
.
canAddElement
in interface ILcdModel
canAddElement
in interface ILcdModelTreeNode
canAddElement
in class ALcdModel
aElement
- the element to be verified.true
if the specified element can be added to this model, false
otherwise.public void addElement(Object aElement, int aEventMode)
ALcdModel
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.
This implementation always throws an UnsupportedOperationException
.
addElement
in interface ILcdModel
addElement
in interface ILcdModelTreeNode
addElement
in class ALcdModel
aElement
- the element to be added to this model.aEventMode
- the mode for sending out the model change event. This can be FIRE_LATER
or NO_EVENT
.ILcdModel.canAddElement(Object)
public void addElements(Vector aElements, int aEventMode)
ALcdModel
ILcdBounded
. 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.
This implementation iterates over all elements in the specified vector, and calls
addElement(Object, int)
for each element to be added, using event mode NO_EVENT
if the
specified event mode is NO_EVENT
, FIRE_LATER
otherwise.
If the specified event mode is FIRE_NOW
, fireCollectedModelChanges()
is called afterwards.
addElements
in interface ILcdModel
addElements
in interface ILcdModelTreeNode
addElements
in class ALcdModel
aElements
- the vector of elements to be added to this model.aEventMode
- the mode for sending the model change events This can be FIRE_LATER
or NO_EVENT
.ILcdModel.canAddElement(Object)
public boolean canRemoveElement(Object aElement)
ALcdModel
true
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 implementation always returns false
.
canRemoveElement
in interface ILcdModel
canRemoveElement
in interface ILcdModelTreeNode
canRemoveElement
in class ALcdModel
aElement
- the element to be verified.true
if the specified element can be removed from this model, false
otherwise.public void removeElement(Object aElement, int aEventMode)
ALcdModel
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.
This implementation always throws an UnsupportedOperationException
.
removeElement
in interface ILcdModel
removeElement
in interface ILcdModelTreeNode
removeElement
in class ALcdModel
aElement
- the element to be removed from this model.aEventMode
- the mode for sending out the model change event. This can be FIRE_LATER
or NO_EVENT
.ILcdModel.canRemoveElement(Object)
public void removeElements(Vector aElements, int aEventMode)
ALcdModel
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.
This implementation iterates over all elements in the specified vector, and calls
removeElement(Object, int)
for each element to be removed, using event mode NO_EVENT
if the
specified event mode is NO_EVENT
, FIRE_LATER
otherwise.
If the specified event mode is FIRE_NOW
, fireCollectedModelChanges()
is called afterwards.
removeElements
in interface ILcdModel
removeElements
in interface ILcdModelTreeNode
removeElements
in class ALcdModel
aElements
- the vector of elements to be removed from this model.aEventMode
- the mode for sending out the model change event. This can be FIRE_LATER
or NO_EVENT
.ILcdModel.canRemoveElement(Object)
public void removeAllElements(int aEventMode)
ALcdModel
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.
This implementation iterates over all elements in the model, and calls
removeElement(Object, int)
for each element to be removed, using event mode NO_EVENT
if the
specified event mode is NO_EVENT
, FIRE_LATER
otherwise.
If the specified event mode is FIRE_NOW
, fireCollectedModelChanges()
is called afterwards.
removeAllElements
in interface ILcdModel
removeAllElements
in interface ILcdModelTreeNode
removeAllElements
in class ALcdModel
aEventMode
- the mode for sending out the model change event. This can be FIRE_LATER
or NO_EVENT
.public void elementChanged(Object aElement, int aEventMode)
ALcdModel
This implementation calls TLcdModelChangedEventSupport#elementChanged(Object, int)
.
elementChanged
in interface ILcdModel
elementChanged
in interface ILcdModelTreeNode
elementChanged
in class ALcdModel
aElement
- the element that has changed.aEventMode
- the mode for sending out the model change event. This can be FIRE_LATER
or NO_EVENT
.public void elementsChanged(Vector aElements, int aEventMode)
ALcdModel
This implementation calls TLcdModelChangedEventSupport#elementsChanged(java.util.Vector, int)
.
elementsChanged
in interface ILcdModel
elementsChanged
in interface ILcdModelTreeNode
elementsChanged
in class ALcdModel
aElements
- the vector of elements that have changed.aEventMode
- the mode for sending out the model change event. This can be FIRE_LATER
or NO_EVENT
.public void fireCollectedModelChanges()
ALcdModel
This implementation calls #TLcdModelChangedEventSupport#fireCollectedModelChanges()
.
fireCollectedModelChanges
in interface ILcdModel
fireCollectedModelChanges
in interface ILcdModelTreeNode
fireCollectedModelChanges
in class ALcdModel
ILcdModelListener.modelChanged(TLcdModelChangedEvent)
public void addModelListener(ILcdModelListener aModelListener)
ALcdModel
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.
This implementation calls TLcdModelChangedEventSupport#addModelListener(ILcdModelListener)
.
addModelListener
in interface ILcdModel
addModelListener
in interface ILcdModelTreeNode
addModelListener
in class ALcdModel
aModelListener
- the ILcdModelListener
to register on this model.ILcdModel.removeModelListener(com.luciad.model.ILcdModelListener)
,
ILcdModelListener
public void removeModelListener(ILcdModelListener aModelListener)
ALcdModel
This implementation calls TLcdModelChangedEventSupport#removeModelListener(ILcdModelListener)
.
removeModelListener
in interface ILcdModel
removeModelListener
in interface ILcdModelTreeNode
removeModelListener
in class ALcdModel
aModelListener
- the ILcdModelListener
to remove.ILcdModel.addModelListener(com.luciad.model.ILcdModelListener)
,
ILcdModelListener
public void dispose()
ALcdModel
finalize
) on this model subsequent to a call to
this method is undefined.
When a model disposer has been provided it is called, otherwise this method does nothing.
When overriding this method it is recommended to call super.dispose()
.
dispose
in interface ILcdModel
dispose
in interface ILcdModelTreeNode
dispose
in interface ILcdDisposable
dispose
in class ALcdModel
ALcdModel.setModelDisposer(Consumer)
public int applyOnInteract2DBounds(ILcdBounds aBounds, boolean aStrictInteract, ILcdFunction aFunctionToApply, double aPrecisionX, double aPrecisionY)
Calls the custom applyOnInteract2DBounds
method, with the following default
parameters:
applyOnInteract2DBounds
in interface ILcd2DBoundsIndexedModel
aBounds
- the rectangle to test overlap with.aStrictInteract
- if false
, the spatial search may return more elements than the
ones strictly overlapping; if true
, 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.aPrecisionY
- the precision required in the y dimension, expressed in model
units.ILcdFunction
has been applied.public int applyOnInteract2DBounds(ILcdBounds aBounds, boolean aStrictInteract, ILcdFunction aFunctionToApply, double aPrecisionX, double aPrecisionY, double aMinSizeX, double aMinSizeY, boolean aIncludePoints)
Calls the custom applyOnInteract2DBounds
method, with the following default
parameters:
applyOnInteract2DBounds
in interface ILcd2DBoundsIndexedModel
applyOnInteract2DBounds
in interface ILcd2DBoundsInteractable
aBounds
- the rectangle to test overlap with.aStrictInteract
- if false
, the spatial search may return more elements than the
ones strictly overlapping; if true
, 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.aPrecisionY
- the precision required in the y dimension, expressed in model
units.aMinSizeX
- the minimal element size in the x dimension, expressed in model
units.aMinSizeY
- the minimal element size in the y dimension, expressed in model
units.aIncludePoints
- if true
, zero-sized elements (points) are considered as well,
even though they might be smaller than the minimum size.ILcdFunction
has been applied.public void modelProduced(TLcdModelProducerEvent aModelProducerEvent)
ILcdModelProducerListener
modelProduced
in interface ILcdModelProducerListener
aModelProducerEvent
- the event describing the changes to a ILcdModelProducer
.public int modelCount()
ILcdModelTreeNode
Returns the number of child models of this model node.
modelCount
in interface ILcdModelContainer
modelCount
in interface ILcdModelTreeNode
public TLcdKML22DynamicModel getModel(int aIndex)
ILcdModelTreeNode
Returns the child model at the given index.
getModel
in interface ILcdModelContainer
getModel
in interface ILcdModelTreeNode
aIndex
- a valid index in this ILcdModelTreeNode
public Enumeration models()
ILcdModelTreeNode
Returns an Enumeration
of the child models of this
ILcdModelTreeNode
.
models
in interface ILcdModelContainer
models
in interface ILcdModelTreeNode
Enumeration
of the child models of this ILcdModelTreeNode
.public boolean addModel(ILcdModel aModel)
ILcdModelTreeNode
Adds the ILcdModel aModel
as a child model to this
ILcdModelTreeNode
.
addModel
in interface ILcdModelContainer
addModel
in interface ILcdModelTreeNode
aModel
- the model to be added.true
if this collection of models changed as a result of the callpublic boolean removeModel(ILcdModel aModel)
ILcdModelTreeNode
Removes the child model aModel
from this ILcdModelTreeNode
.
removeModel
in interface ILcdModelContainer
removeModel
in interface ILcdModelTreeNode
aModel
- the model to be removed.true
if a model was removed as a result of this callpublic void addModelContainerListener(ILcdModelContainerListener aModelContainerListener)
ILcdModelTreeNode
ILcdModelContainerListener
to this ILcdModelContainer
.
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 (see ILcdModelTreeNode.addHierarchyModelContainerListener(ILcdModelContainerListener)
).
addModelContainerListener
in interface ILcdModelContainer
addModelContainerListener
in interface ILcdModelTreeNode
aModelContainerListener
- the listener to be added.ILcdModelContainer.removeModelContainerListener(com.luciad.model.ILcdModelContainerListener)
public void removeModelContainerListener(ILcdModelContainerListener aModelContainerListener)
ILcdModelTreeNode
ILcdModelContainerListener
from this ILcdModelContainer
.
It is not possible to remove a hierarchy model container listener. Use ILcdModelTreeNode.removeHierarchyModelContainerListener(ILcdModelContainerListener)
for this purpose.
removeModelContainerListener
in interface ILcdModelContainer
removeModelContainerListener
in interface ILcdModelTreeNode
aModelContainerListener
- the listener to be removed.ILcdModelContainer.addModelContainerListener(com.luciad.model.ILcdModelContainerListener)
public boolean isEmpty()
ILcdModelTreeNode
Returns true
when the model node is only used as a container for other models,
and contains no useful data itself, false
otherwise.
isEmpty
in interface ILcdModelTreeNode
true
when the model node contains no useful data, false
otherwisepublic void addHierarchyModelContainerListener(ILcdModelContainerListener aModelContainerListener)
ILcdModelTreeNode
Registers the given ILcdModelContainerListener
to receive TLcdModelContainerEvent
s from all the
ILcdModelTreeNode
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 (see ILcdModelTreeNode.addModelContainerListener(ILcdModelContainerListener)
).
The source ILcdModelContainer
of the event can be retrieved by calling TLcdModelContainerEvent.getModelContainer()
on the received TLcdModelContainerEvent
.
addHierarchyModelContainerListener
in interface ILcdModelTreeNode
aModelContainerListener
- the listenerILcdModelTreeNode.removeHierarchyModelContainerListener(ILcdModelContainerListener)
public void removeHierarchyModelContainerListener(ILcdModelContainerListener aModelContainerListener)
ILcdModelTreeNode
Unregisters the given ILcdModelContainerListener
from receiving TLcdModelContainerEvent
s for the tree
with this node as root node.
removeHierarchyModelContainerListener
in interface ILcdModelTreeNode
aModelContainerListener
- the listenerILcdModelTreeNode.addHierarchyModelContainerListener(ILcdModelContainerListener)
public void addHierarchyModelListener(ILcdModelListener aModelListener)
ILcdModelTreeNode
Registers the given ILcdModelListener
to receive
TLcdModelChangedEvent
s from all the ILcdModel
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 (see ILcdModelTreeNode.addModelListener(ILcdModelListener)
).
The source ILcdModel
of the event can be retrieved by calling TLcdModelChangedEvent.getModel()
on the received TLcdModelChangedEvent
.
addHierarchyModelListener
in interface ILcdModelTreeNode
aModelListener
- the listenerILcdModelTreeNode.removeHierarchyModelListener(ILcdModelListener)
public void removeHierarchyModelListener(ILcdModelListener aModelListener)
ILcdModelTreeNode
Unregisters the given ILcdModelListener
from
receiving TLcdModelChangedEvent
s for the tree with this node as root node.
removeHierarchyModelListener
in interface ILcdModelTreeNode
aModelListener
- the listenerILcdModelTreeNode.addHierarchyModelListener(ILcdModelListener)
public ILcdBounds getBounds()
ILcdBounded
ILcdBounds
by which the geometry of this ILcdBounded
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
of TLcdLonLatBounds
or TLcdXYBounds
.
getBounds
in interface ILcdBounded
ILcdBounds
by which the geometry of this ILcdBounded
object
is bounded.public Lock readLock()
readLock
in interface ReadWriteLock
public Lock writeLock()
writeLock
in interface ReadWriteLock
public void updateNetworkLink()
Updates the NetworkLink of this TLcdKML22DynamicModel (if any). This method does not need to be called explicitly for most KML files. It can be called if a NetworkLink needs to be refreshed manually, or if you wish to retry loading a NetworkLink that has previously failed.
The status of this dynamic model can be monitored using status
listeners
or by polling the status
.
Note that this method initiates an asynchronous retrieval to refresh a KML NetworkLink. The result of this call may or may not be immediate and can be performed on a separate thread.
This method does nothing if the dynamic model has been disposed.