public class TLcdSoft2DBoundsIndexedModel extends Object implements ILcd2DBoundsIndexedModel
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:
setAnticipatedModelReference(ILcdModelReference)
)setAnticipatedModelDescriptor(com.luciad.model.ILcdModelDescriptor)
)setAnticipatedModelBounds(com.luciad.shape.ILcdBounds)
)The model is read-only. It is thread-safe for accessing its contained model.
ILcdModel.Query
FIRE_LATER, FIRE_NOW, NO_EVENT
Constructor and Description |
---|
TLcdSoft2DBoundsIndexedModel()
Constructs a new
TLcdSoft2DBoundsIndexedModel . |
TLcdSoft2DBoundsIndexedModel(String aSource,
ILcdModelDecoder aModelDecoder)
Constructs a new
TLcdSoft2DBoundsIndexedModel with the specified source and corresponding model decoder. |
TLcdSoft2DBoundsIndexedModel(String aSource,
ILcdModelDecoder aModelDecoder,
ILcd2DBoundsIndexedModel aModel)
Constructs a new
TLcdSoft2DBoundsIndexedModel 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 new
TLcdSoft2DBoundsIndexedModel with the specified source and corresponding model decoder,
model reference and model bounds. |
Modifier and Type | Method and Description |
---|---|
void |
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)
Returns
true if the specified element can be added to this model, false otherwise. |
boolean |
canRemoveElement(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(Object aObject,
int aEventMode)
Notifies this model that the specified element has changed.
|
Enumeration |
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 |
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. |
ILcdModelDecoder |
getModelDecoder()
Gets the
ILcdModelDecoder for this ILcdModel . |
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 |
getSource()
Gets the source of this model.
|
static boolean |
isClassTraceOn()
Deprecated.
This method has been deprecated. It is recommended to use the
standard Java logging framework directly.
|
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 the
ILcdBounds of this ILcdModel . |
void |
setAnticipatedModelDescriptor(ILcdModelDescriptor aAnticipatedModelDescriptor)
Sets the
ILcdModelDescriptor of this ILcdModel . |
void |
setAnticipatedModelReference(ILcdModelReference aAnticipatedModelReference)
Sets the
ILcdModelReference of this ILcdModel . |
static void |
setClassTraceOn(boolean aClassTraceOn)
Deprecated.
This method has been deprecated. It is recommended to use the
standard Java logging framework directly.
|
void |
setModelDecoder(ILcdModelDecoder aModelDecoder)
Sets the
ILcdModelDecoder for this ILcdModel . |
void |
setSource(String aSource)
Sets the source of this model.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
query
all, filter, getModelMetadata
close
public TLcdSoft2DBoundsIndexedModel()
TLcdSoft2DBoundsIndexedModel
. The user has to set a valid source
(setSource(String)
) and corresponding model decoder setModelDecoder(ILcdModelDecoder)
) before
using this model.public TLcdSoft2DBoundsIndexedModel(String aSource, ILcdModelDecoder aModelDecoder)
TLcdSoft2DBoundsIndexedModel
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.
aSource
- the source of the model to be loaded.aModelDecoder
- the model decoder that can decode the specified source.TLcdSoft2DBoundsIndexedModel(String, ILcdModelDecoder, ILcdModelReference, com.luciad.shape.ILcdBounds)
public TLcdSoft2DBoundsIndexedModel(String aSource, ILcdModelDecoder aModelDecoder, ILcdModelReference aModelReference, ILcdBounds aModelBounds)
TLcdSoft2DBoundsIndexedModel
with the specified source and corresponding model decoder,
model reference and model bounds.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.public TLcdSoft2DBoundsIndexedModel(String aSource, ILcdModelDecoder aModelDecoder, ILcd2DBoundsIndexedModel aModel)
TLcdSoft2DBoundsIndexedModel
with the specified source and corresponding model decoder,
and an already decoded model instance.
The decoded instance is cached in a SoftReference
. The model reference, model descriptor and model
bounds are are also cached in this model.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.public static void setClassTraceOn(boolean aClassTraceOn)
true
then all log messages are recorded, otherwise only
the informative, warning and error messages are recorded.aClassTraceOn
- if true then all log messages are recorded,
otherwise only the informative, warning and error messages are recorded.public static boolean isClassTraceOn()
true
if tracing is enabled for this class.public void setSource(String aSource)
aSource
- the source of the model.getSource()
public String getSource()
setSource(java.lang.String)
public void setModelDecoder(ILcdModelDecoder aModelDecoder)
ILcdModelDecoder
for this ILcdModel
.aModelDecoder
- the model decoder for decoding the source into a
model.getModelDecoder()
public ILcdModelDecoder getModelDecoder()
ILcdModelDecoder
for this ILcdModel
.ILcdModelDecoder
for this ILcdModel
.setModelDecoder(com.luciad.model.ILcdModelDecoder)
public void setAnticipatedModelReference(ILcdModelReference aAnticipatedModelReference)
ILcdModelReference
of this ILcdModel
.
Optional property used for optimized usage of this TLcdSoft2DBoundsIndexedModel
.aAnticipatedModelReference
- the anticipated model reference of the
model.public void setAnticipatedModelBounds(ILcdBounds aAnticipatedModelBounds)
ILcdBounds
of this ILcdModel
. Optional
property used for optimized usage of this TLcdSoft2DBoundsIndexedModel
.aAnticipatedModelBounds
- the anticipated model bounds of the model.public void setAnticipatedModelDescriptor(ILcdModelDescriptor aAnticipatedModelDescriptor)
ILcdModelDescriptor
of this ILcdModel
.
Optional property used for optimized usage of this TLcdSoft2DBoundsIndexedModel
.aAnticipatedModelDescriptor
- the anticipated model descriptor of the
model.public ILcdModelReference getModelReference()
ILcdModel
ILcdModelReference
describing how the geometry of the elements contained in this
model should be interpreted.getModelReference
in interface ILcdModel
ILcdModelReference
of this ILcdModel
.public ILcdModelDescriptor getModelDescriptor()
ILcdModel
ILcdModelDescriptor
providing meta information about this model and
its elements.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 Enumeration elements()
ILcdModel
public void addElement(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(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
.
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(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(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(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
.
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(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(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(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 life-time 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
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 multi-leveled data (multiple representations of the same object, but with varying accuracy), so that the most appropriate accuracy level can be used. 0 means best possible accuracy, but it might trigger lazy-loaded implementations to load lots of data.
aPrecisionY
- the precision required in the y dimension, expressed in model units.ILcdFunction
has been applied.public int applyOnInteract2DBounds(ILcdBounds aBounds, boolean aStrictInteract, ILcdFunction aFunctionToApply, double aPrecisionX, double aPrecisionY, double aMinSizeX, double aMinSizeY, boolean aIncludePoints)
ILcd2DBoundsInteractable
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 multi-leveled data (multiple representations of the same object, but with varying accuracy), so that the most appropriate accuracy level can be used. 0 means best possible accuracy, but it might trigger lazy-loaded implementations to load lots of data.
aPrecisionY
- the precision required in the y dimension, expressed in model units.aMinSizeX
- the minimal element size in the x dimension (as 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
, zero-sized elements (points) are considered as well, even though they
might be smaller than the minimum size.ILcdFunction
has been applied.