Class TLcdSoft2DBoundsIndexedModel
 All Implemented Interfaces:
ILcd2DBoundsIndexedModel
,ILcd2DBoundsInteractable
,ILcdModel
,ILcdBounded
,ILcdDisposable
,Serializable
,AutoCloseable
ILcd2DBoundsIndexedModel
that lazily loads its contents when they are first queried.
This model requires a source name and a model decoder that can decode the source. The model decoder should return
an ILcd2DBoundsIndexedModel
. The model will only be loaded into memory when its properties or its elements
are requested. It is then cached in a SoftReference
.
Some properties of a model are almost immediately queried when the model is added to a view. To postpone the loading of the underlying model as long as possible, one can set these properties on this model, if they are known beforehand:
 model reference (
setAnticipatedModelReference(ILcdModelReference)
)  model descriptor (
setAnticipatedModelDescriptor(com.luciad.model.ILcdModelDescriptor)
)  model bounds (
setAnticipatedModelBounds(com.luciad.shape.ILcdBounds)
)
The model is readonly. It is threadsafe for accessing its contained model.
 See Also:

Nested Class Summary
Nested classes/interfaces inherited from interface com.luciad.model.ILcdModel
ILcdModel.Query

Field Summary
Fields inherited from interface com.luciad.model.ILcdModel
FIRE_LATER, FIRE_NOW, NO_EVENT

Constructor Summary
ConstructorDescriptionConstructs a newTLcdSoft2DBoundsIndexedModel
.TLcdSoft2DBoundsIndexedModel
(String aSource, ILcdModelDecoder aModelDecoder) Constructs a newTLcdSoft2DBoundsIndexedModel
with the specified source and corresponding model decoder.TLcdSoft2DBoundsIndexedModel
(String aSource, ILcdModelDecoder aModelDecoder, ILcd2DBoundsIndexedModel aModel) Constructs a newTLcdSoft2DBoundsIndexedModel
with the specified source and corresponding model decoder, and an already decoded model instance.TLcdSoft2DBoundsIndexedModel
(String aSource, ILcdModelDecoder aModelDecoder, ILcdModelReference aModelReference, ILcdBounds aModelBounds) Constructs a newTLcdSoft2DBoundsIndexedModel
with the specified source and corresponding model decoder, model reference and model bounds. 
Method Summary
Modifier and TypeMethodDescriptionvoid
addElement
(Object aObject, int aEventMode) Adds the specified element to this model.void
addElements
(Vector aObjects, int aEventMode) Adds all of the elements in the specified vector 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
(Object aObject) Returnstrue
if the specified element can be added to this model,false
otherwise.boolean
canRemoveElement
(Object aObject) 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 aObject, int aEventMode) Notifies this model that the specified element has changed.elements()
Returns an enumeration over all elements of this model.void
elementsChanged
(Vector aObjects, 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 theILcdBounds
by which the geometry of thisILcdBounded
object is bounded.Gets theILcdModelDecoder
for thisILcdModel
.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.Returns theILcdModelReference
describing how the geometry of the elements contained in this model should be interpreted.Gets the source of this model.static boolean
Deprecated.This method has been deprecated.void
removeAllElements
(int aEventMode) Removes all elements from this model.void
removeElement
(Object aObject, int aEventMode) Removes the specified element from this model.void
removeElements
(Vector aObjects, int aEventMode) Removes all of the elements in the specified vector 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
setAnticipatedModelBounds
(ILcdBounds aAnticipatedModelBounds) Sets theILcdBounds
of thisILcdModel
.void
setAnticipatedModelDescriptor
(ILcdModelDescriptor aAnticipatedModelDescriptor) Sets theILcdModelDescriptor
of thisILcdModel
.void
setAnticipatedModelReference
(ILcdModelReference aAnticipatedModelReference) Sets theILcdModelReference
of thisILcdModel
.static void
setClassTraceOn
(boolean aClassTraceOn) Deprecated.This method has been deprecated.void
setModelDecoder
(ILcdModelDecoder aModelDecoder) Sets theILcdModelDecoder
for thisILcdModel
.void
Sets the source of this model.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.luciad.model.ILcd2DBoundsIndexedModel
query
Methods inherited from interface com.luciad.util.ILcdDisposable
close
Methods inherited from interface com.luciad.model.ILcdModel
getModelMetadata

Constructor Details

TLcdSoft2DBoundsIndexedModel
public TLcdSoft2DBoundsIndexedModel()Constructs a newTLcdSoft2DBoundsIndexedModel
. The user has to set a valid source (setSource(String)
) and corresponding model decodersetModelDecoder(ILcdModelDecoder)
) before using this model. 
TLcdSoft2DBoundsIndexedModel
Constructs a newTLcdSoft2DBoundsIndexedModel
with the specified source and corresponding model decoder.For optimal performance, one should consider also setting the model reference, model descriptor and model bounds on this model, if they are known without loading the actual model.
 Parameters:
aSource
 the source of the model to be loaded.aModelDecoder
 the model decoder that can decode the specified source. See Also:

TLcdSoft2DBoundsIndexedModel
public TLcdSoft2DBoundsIndexedModel(String aSource, ILcdModelDecoder aModelDecoder, ILcdModelReference aModelReference, ILcdBounds aModelBounds) Constructs a newTLcdSoft2DBoundsIndexedModel
with the specified source and corresponding model decoder, model reference and model bounds. Parameters:
aSource
 the source of the model to be loaded.aModelDecoder
 the model decoder that can decode the specified source.aModelReference
 the model reference of this model.aModelBounds
 the model bounds of this model.

TLcdSoft2DBoundsIndexedModel
public TLcdSoft2DBoundsIndexedModel(String aSource, ILcdModelDecoder aModelDecoder, ILcd2DBoundsIndexedModel aModel) Constructs a newTLcdSoft2DBoundsIndexedModel
with the specified source and corresponding model decoder, and an already decoded model instance. The decoded instance is cached in aSoftReference
. The model reference, model descriptor and model bounds are are also cached in this model. Parameters:
aSource
 the source of the model to be loaded.aModelDecoder
 the model decoder that can decode the specified source.aModel
 an already decoded model instance.


Method Details

setClassTraceOn
public static void setClassTraceOn(boolean aClassTraceOn) Deprecated.This method has been deprecated. It is recommended to use the standard Java logging framework directly.Enables tracing for all instances of this class. If the argument istrue
then all log messages are recorded, otherwise only the informative, warning and error messages are recorded. Parameters:
aClassTraceOn
 if true then all log messages are recorded, otherwise only the informative, warning and error messages are recorded.

isClassTraceOn
public static boolean isClassTraceOn()Deprecated.This method has been deprecated. It is recommended to use the standard Java logging framework directly.Returnstrue
if tracing is enabled for this class. Returns:
 true if tracing is enabled for this class, false otherwise.

setSource
Sets the source of this model. Parameters:
aSource
 the source of the model. See Also:

getSource
Gets the source of this model. Returns:
 the source of this model.
 See Also:

setModelDecoder
Sets theILcdModelDecoder
for thisILcdModel
. Parameters:
aModelDecoder
 the model decoder for decoding the source into a model. See Also:

getModelDecoder
Gets theILcdModelDecoder
for thisILcdModel
. Returns:
 the
ILcdModelDecoder
for thisILcdModel
.  See Also:

setAnticipatedModelReference
Sets theILcdModelReference
of thisILcdModel
. Optional property used for optimized usage of thisTLcdSoft2DBoundsIndexedModel
. Parameters:
aAnticipatedModelReference
 the anticipated model reference of the model.

setAnticipatedModelBounds
Sets theILcdBounds
of thisILcdModel
. Optional property used for optimized usage of thisTLcdSoft2DBoundsIndexedModel
. Parameters:
aAnticipatedModelBounds
 the anticipated model bounds of the model.

setAnticipatedModelDescriptor
Sets theILcdModelDescriptor
of thisILcdModel
. Optional property used for optimized usage of thisTLcdSoft2DBoundsIndexedModel
. Parameters:
aAnticipatedModelDescriptor
 the anticipated model descriptor of the model.

getModelReference
Description copied from interface:ILcdModel
Returns theILcdModelReference
describing how the geometry of the elements contained in this model should be interpreted. Specified by:
getModelReference
in interfaceILcdModel
 Returns:
 the
ILcdModelReference
of thisILcdModel
.

getModelDescriptor
Description copied from interface:ILcdModel
Returns theILcdModelDescriptor
providing meta information about this model and its elements. Specified by:
getModelDescriptor
in interfaceILcdModel
 Returns:
 the
ILcdModelDescriptor
of thisILcdModel
. Should not benull
.

getModelEncoder
Description copied from interface:ILcdModel
Returns, if available, a model encoder that is capable of encoding this model, (encoder.canEncode(this)
),null
otherwise. Specified by:
getModelEncoder
in interfaceILcdModel
 Returns:
 a model encoder that is capable of encoding this model if available,
null
otherwise.

elements
Description copied from interface:ILcdModel
Returns an enumeration over all elements of this model. The order in which the elements are enumerated is unspecified by default. 
addElement
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.This implementation always throws an
IllegalArgumentException
(this model is not editable). Specified by:
addElement
in interfaceILcdModel
 Parameters:
aObject
 the element to be added to this model.aEventMode
 the mode for sending out the model change event. This can beFIRE_LATER
orNO_EVENT
. See Also:

canAddElement
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 implementation always returns
false
. Specified by:
canAddElement
in interfaceILcdModel
 Parameters:
aObject
 the element to be verified. Returns:
true
if the specified element can be added to this model,false
otherwise.

addElements
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.This implementation always throws an
IllegalArgumentException
(this model is not editable). Specified by:
addElements
in interfaceILcdModel
 Parameters:
aObjects
 the vector of elements to be added to this model.aEventMode
 the mode for sending the model change events This can beFIRE_LATER
orNO_EVENT
. See Also:

removeElement
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.This implementation always throws an
IllegalArgumentException
(this model is not editable). Specified by:
removeElement
in interfaceILcdModel
 Parameters:
aObject
 the element to be removed from this model.aEventMode
 the mode for sending out the model change event. This can beFIRE_LATER
orNO_EVENT
. See Also:

canRemoveElement
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 implementation always returns
false
. Specified by:
canRemoveElement
in interfaceILcdModel
 Parameters:
aObject
 the element to be verified. Returns:
true
if the specified element can be removed from this model,false
otherwise.

removeElements
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.This implementation always throws an
IllegalArgumentException
(this model is not editable). Specified by:
removeElements
in interfaceILcdModel
 Parameters:
aObjects
 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) 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.This implementation always throws an
IllegalArgumentException
(this model is not editable). Specified by:
removeAllElements
in interfaceILcdModel
 Parameters:
aEventMode
 the mode for sending out the model change event. This can beFIRE_LATER
orNO_EVENT
.

elementChanged
Notifies this model that the specified element has changed.This implementation always throws an
IllegalArgumentException
(this model is not editable). Specified by:
elementChanged
in interfaceILcdModel
 Parameters:
aObject
 the element that has changed.aEventMode
 the mode for sending out the model change event. This can beFIRE_LATER
orNO_EVENT
.

elementsChanged
Notifies this model that the elements in the specified vector have changed.This implementation always throws an
IllegalArgumentException
(this model is not editable). Specified by:
elementsChanged
in interfaceILcdModel
 Parameters:
aObjects
 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()Notifies all listeners that are registered on this model of all the changes that have been collected between the previous notification and now.This implementation does nothing (this model is not editable).
 Specified by:
fireCollectedModelChanges
in interfaceILcdModel
 See Also:

addModelListener
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).
 Specified by:
addModelListener
in interfaceILcdModel
 Parameters:
aModelListener
 theILcdModelListener
to register on this model. See Also:

removeModelListener
Unregisters the specified model listener so that it no longer receives notifications of model changes on this model.This implementation does nothing (this model is not editable).
 Specified by:
removeModelListener
in interfaceILcdModel
 Parameters:
aModelListener
 theILcdModelListener
to remove. See Also:

dispose
public void dispose()Description copied from interface:ILcdModel
Disposes of this model and allows it to release any system resources that it is holding. The result of calling any other method (other thanfinalize
) on this model subsequent to a call to this method is undefined. Specified by:
dispose
in interfaceILcdDisposable
 Specified by:
dispose
in interfaceILcdModel

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.

applyOnInteract2DBounds
public int applyOnInteract2DBounds(ILcdBounds aBounds, boolean aStrictInteract, ILcdFunction aFunctionToApply, double aPrecisionX, double aPrecisionY) Description copied from interface:ILcd2DBoundsIndexedModel
Applies the specified function to all the model elements of which the 2D bounds overlap with the specified bounds. By default, the order in which the function is applied on the elements is unspecified and depends on the implementation.The return value of the specified function is used as a stop criterion: the spatial query is interrupted if the function returns
false
. Specified by:
applyOnInteract2DBounds
in interfaceILcd2DBoundsIndexedModel
 Parameters:
aBounds
 the rectangle to test overlap with.aStrictInteract
 iffalse
, the spatial search may return more elements than the ones strictly overlapping; iftrue
, the search only returns the elements that are overlapping. The latter mode is more precise, but it may be slower.aFunctionToApply
 the function to apply on each element that overlaps with the given bounds. The return value of the specified function is used as a stop criterion: the spatial query is interrupted if the function returnsfalse
.aPrecisionX
 the precision required in the x dimension, expressed in model units. For example, for a cartesian grid system expressed in meters, the values should be expressed in meters as well, for a geodetic coordinate system the accuracy values should be expressed in degrees.The precision is useful in combination with 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. Returns:
 the number of elements to which the
ILcdFunction
has been applied.

applyOnInteract2DBounds
public int applyOnInteract2DBounds(ILcdBounds aBounds, boolean aStrictInteract, ILcdFunction aFunctionToApply, double aPrecisionX, double aPrecisionY, double aMinSizeX, double aMinSizeY, boolean aIncludePoints) Description copied from interface:ILcd2DBoundsInteractable
Applies the specified function to all the elements of which the 2D bounds overlap with the specified bounds. The order in which the function is applied on the elements is unspecified and depends on the implementation.Only elements that have at least the specified minimal size in the x dimension or in the y dimension are considered. This can be useful for quickly eliminating elements that are too small to be visible in a view, for instance. If required, an exception can be made for point elements, which have a size of 0 by 0. They can be forced to be considered, even though they would always be rejected as being too small for any sizes larger than 0.
The return value of the specified function is used as a stop criterion: the spatial query will be interrupted as soon as the function returns
false
for an element it was applied on. Specified by:
applyOnInteract2DBounds
in interfaceILcd2DBoundsIndexedModel
 Specified by:
applyOnInteract2DBounds
in interfaceILcd2DBoundsInteractable
 Parameters:
aBounds
 the rectangle to test overlap with.aStrictInteract
 iffalse
, the spatial search may return more elements than the ones strictly overlapping; iftrue
, the search only returns the elements that are overlapping. The latter mode is more precise, but it may be slower.aFunctionToApply
 the function to apply on each element that overlaps with the given bounds.aPrecisionX
 the precision required in the x dimension, expressed in model units. For example, for a cartesian grid system expressed in meters, the values should be expressed in meters as well, for a geodetic coordinate system the accuracy values should be expressed in degrees.The precision is useful in combination with 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 inILcdBounds.getWidth()
), expressed in model units. Elements that are smaller than this size will be skipped. This may, for example, be useful when improving the efficiency of painting elements by skipping elements that are smaller than some threshold (e.g. one pixel, converted to model units).aMinSizeY
 the minimal element size in the y dimension (as inILcdBounds.getHeight()
), expressed in model units.aIncludePoints
 iftrue
, zerosized elements (points) are considered as well, even though they might be smaller than the minimum size. Returns:
 the number of elements to which the
ILcdFunction
has been applied.
