public class TLcdTiled2DBoundsIndexedModel extends java.lang.Object implements ILcd2DBoundsIndexedModel
ILcd2DBoundsIndexedModel
that is composed of other ILcd2DBoundsIndexedModel
objects. It contains as elements the union of the elements of its submodels. The submodels are stored in a spatially
indexed structure for efficient access.
The model reference and model descriptor of this model can be set using setters. If they are not set, they are retrieved from a random submodel.
This model is a readonly model. It is threadsafe for accessing its submodels.
ILcdModel.Query
FIRE_LATER, FIRE_NOW, NO_EVENT
Constructor and Description 

TLcdTiled2DBoundsIndexedModel()
Constructs a new, empty
TLcdTiled2DBoundsIndexedModel . 
TLcdTiled2DBoundsIndexedModel(ILcd2DBoundsIndexedModel a2DBoundsIndexedModel)
Constructs a new
TLcdTiled2DBoundsIndexedModel , initialized with the specified model. 
TLcdTiled2DBoundsIndexedModel(ILcdBounds aModelBounds)
Constructs a new, empty
TLcdTiled2DBoundsIndexedModel , initialized with the specified initial bounds. 
Modifier and Type  Method and Description 

void 
addElement(java.lang.Object aObject,
int aEventMode)
Adds the specified element to this model.

void 
addElements(java.util.Vector aObjects,
int aEventMode)
Adds all of the elements in the specified vector to this model.

void 
addModel(ILcd2DBoundsIndexedModel aModel,
int aFireEventMode)
Adds a submodel to this model.

void 
addModelListener(ILcdModelListener aModelListener)
Registers the specified model listener to receive notifications of model changes on this model.

int 
applyOnInteract2DBounds(ILcdBounds aBounds,
boolean aStrictInteract,
ILcdFunction aFunctionToApply,
double aPrecisionX,
double aPrecisionY)
Applies the specified function to all the model elements of which the 2D bounds overlap with the specified bounds.

int 
applyOnInteract2DBounds(ILcdBounds aBounds,
boolean aStrictInteract,
ILcdFunction aFunctionToApply,
double aPrecisionX,
double aPrecisionY,
double aMinSizeX,
double aMinSizeY,
boolean aIncludePoints)
Applies the specified function to all the elements of which the 2D bounds overlap with the specified bounds.

boolean 
canAddElement(java.lang.Object aObject)
Returns
true if the specified element can be added to this model, false otherwise. 
boolean 
canRemoveElement(java.lang.Object aObject)
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(java.lang.Object aObject,
int aEventMode)
Notifies this model that the specified element has changed.

java.util.Enumeration 
elements()
Returns an enumeration over all elements of this model.

void 
elementsChanged(java.util.Vector aObjects,
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. 
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. 
java.util.Enumeration 
models()
Returns an enumeration of all the submodels contained in this model.

void 
removeAllElements(int aEventMode)
Removes all elements from this model.

void 
removeElement(java.lang.Object aObject,
int aEventMode)
Removes the specified element from this model.

void 
removeElements(java.util.Vector aObjects,
int aEventMode)
Removes all of the elements in the specified vector from this model.

void 
removeModel(ILcd2DBoundsIndexedModel aModel,
int aFireEventMode)
Removes a submodel from this model.

void 
removeModelListener(ILcdModelListener aModelListener)
Unregisters the specified model listener so that it no longer receives notifications of model changes on this model.

void 
setModelDescriptor(ILcdModelDescriptor aModelDescriptor)
Sets the model descriptor providing meta information about this model and its elements.

void 
setModelReference(ILcdModelReference aModelReference)
Sets the model reference describing how the geometry of the elements contained in this model
should be interpreted.

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
query
all, filter, getModelMetadata
close
public TLcdTiled2DBoundsIndexedModel()
TLcdTiled2DBoundsIndexedModel
.public TLcdTiled2DBoundsIndexedModel(ILcdBounds aModelBounds)
TLcdTiled2DBoundsIndexedModel
, initialized with the specified initial bounds.aModelBounds
 an estimate of the global bounds of all submodels that will be put in this model. If necessary,
the bounds will be expanded, but the more accurate the estimate, the more efficiently the
submodels will be accessed.public TLcdTiled2DBoundsIndexedModel(ILcd2DBoundsIndexedModel a2DBoundsIndexedModel)
TLcdTiled2DBoundsIndexedModel
, initialized with the specified model.
The specified model should either be empty or contain ILcd2DBoundsIndexedModel
objects as elements.a2DBoundsIndexedModel
 the spatially indexed model that will be used to store the submodels of this model.public void setModelReference(ILcdModelReference aModelReference)
aModelReference
 the model reference for this model.getModelReference()
public void setModelDescriptor(ILcdModelDescriptor aModelDescriptor)
aModelDescriptor
 the model descriptor for this model.getModelDescriptor()
public void addModel(ILcd2DBoundsIndexedModel aModel, int aFireEventMode)
aModel
 the submodel to be added to this model.aFireEventMode
 the mode for sending out the TLcdModelChangedEvent
.public void removeModel(ILcd2DBoundsIndexedModel aModel, int aFireEventMode)
aModel
 the submodel to be removed from this model.aFireEventMode
 the mode for sending out the TLcdModelChangedEvent
.public java.util.Enumeration models()
addModel(ILcd2DBoundsIndexedModel, int)
public ILcdModelReference getModelReference()
ILcdModelReference
describing how the geometry of the elements contained in this
model should be interpreted.
This implementation returns the model reference of this model, or the model reference of a random submodel, if no model reference was set on this model.
getModelReference
in interface ILcdModel
ILcdModelReference
of this ILcdModel
.public ILcdModelDescriptor getModelDescriptor()
ILcdModelDescriptor
providing meta information about this model and
its elements.
This implementation returns the model descriptor of this model, or the model descriptor of a random submodel, if no model descriptor was set on this model.
getModelDescriptor
in interface ILcdModel
ILcdModelDescriptor
of this ILcdModel
. Should not be null
.public ILcdModelEncoder getModelEncoder()
ILcdModel
encoder.canEncode(this)
), null
otherwise.getModelEncoder
in interface ILcdModel
null
otherwise.public java.util.Enumeration elements()
ILcdModel
public void addElement(java.lang.Object aObject, int aEventMode)
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 IllegalArgumentException
(this model is not editable).
addElement
in interface ILcdModel
aObject
 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 boolean canAddElement(java.lang.Object aObject)
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
(this model is not editable).
canAddElement
in interface ILcdModel
aObject
 the element to be verified.true
if the specified element can be added to this model, false
otherwise.public void addElements(java.util.Vector aObjects, int aEventMode)
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 always throws an IllegalArgumentException
(this model is not editable).
addElements
in interface ILcdModel
aObjects
 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 void removeElement(java.lang.Object aObject, int aEventMode)
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 IllegalArgumentException
(this model is not editable).
removeElement
in interface ILcdModel
aObject
 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 boolean canRemoveElement(java.lang.Object aObject)
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
(this model is not editable).
canRemoveElement
in interface ILcdModel
aObject
 the element to be verified.true
if the specified element can be removed from this model, false
otherwise.public void removeElements(java.util.Vector aObjects, int aEventMode)
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 always throws an IllegalArgumentException
(this model is not editable).
removeElements
in interface ILcdModel
aObjects
 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)
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 always throws an IllegalArgumentException
(this model is not editable).
removeAllElements
in interface ILcdModel
aEventMode
 the mode for sending out the model change event. This can be FIRE_LATER
or NO_EVENT
.public void elementChanged(java.lang.Object aObject, int aEventMode)
This implementation always throws an IllegalArgumentException
(this model is not editable).
elementChanged
in interface ILcdModel
aObject
 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(java.util.Vector aObjects, int aEventMode)
This implementation always throws an IllegalArgumentException
(this model is not editable).
elementsChanged
in interface ILcdModel
aObjects
 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()
This implementation does nothing (this model is not editable).
fireCollectedModelChanges
in interface ILcdModel
ILcdModelListener.modelChanged(TLcdModelChangedEvent)
public void addModelListener(ILcdModelListener aModelListener)
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 lifetime than this model,
you can use a ALcdWeakModelListener
instance as model listener.
This implementation does nothing (this model is not editable).
addModelListener
in interface ILcdModel
aModelListener
 the ILcdModelListener
to register on this model.ILcdModel.removeModelListener(com.luciad.model.ILcdModelListener)
,
ILcdModelListener
public void removeModelListener(ILcdModelListener aModelListener)
This implementation does nothing (this model is not editable).
removeModelListener
in interface ILcdModel
aModelListener
 the ILcdModelListener
to remove.ILcdModel.addModelListener(com.luciad.model.ILcdModelListener)
,
ILcdModelListener
public void dispose()
ILcdModel
finalize
) on this model subsequent to a call to
this method is undefined.dispose
in interface ILcdModel
dispose
in interface ILcdDisposable
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 int applyOnInteract2DBounds(ILcdBounds aBounds, boolean aStrictInteract, ILcdFunction aFunctionToApply, double aPrecisionX, double aPrecisionY)
ILcd2DBoundsIndexedModel
The return value of the specified function is used as a stop criterion: the spatial query is interrupted
if the function returns false
.
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.
The return value of the specified function is used as a stop criterion: the spatial query is interrupted
if the function returns false
.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 multileveled 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 lazyloaded implementations to load lots of data.
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)
ILcd2DBoundsInteractable
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 returns false
for an element it was applied on.
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.
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 multileveled 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 lazyloaded 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 in
ILcdBounds.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 in
ILcdBounds.getHeight()
), expressed in model units.aIncludePoints
 if true
, zerosized elements (points) are considered as well, even though they
might be smaller than the minimum size.ILcdFunction
has been applied.