@Deprecated public class TLcd2DRegularTiledBoundsIndexedModel extends ALcdModel implements ILcd2DBoundsIndexedModel, ILcdIntegerIndexedModel
ILcd2DBoundsIndexedModel
that is also an ILcdIntegerIndexedModel
for models of which most
elements are located in mutually exclusive geographic tiles.
The prerequisites for using this model are:
This class is thread-safe for read-only access of its elements.
For read-write access, external locking must be used, typically on the model
itself. The utility class TLcdLockUtil
provides convenient methods
readLock(Object)
,
readUnlock(Object)
,
writeLock(Object)
, and
writeUnlock(Object)
to do so.
Before LuciadLightspeed version 7.0, the methods for accessing elements were
synchronized. The current implementation no longer performs this internal
synchronization, mainly for allowing concurrent read-only access and
therefore better performance in multi-threaded applications. Note that
internal synchronization on its own was not sufficient for safe concurrent
reading and writing (e.g. due to the elements()
method, which
returns an enumeration). If internal synchronization is required for
backward compatibility, one can set the static compatibility flag with
setSynchronized(boolean)
, or one can define the system property
com.luciad.model.TLcd2DRegularTiledBoundsIndexedModel.synchronized
when starting up the Java Virtual Machine, typically as follows:
java -Dcom.luciad.model.TLcd2DBoundsIndexedModel.synchronized ....Internal synchronization will then be performed, as in previous versions.
ILcdModel.Query
fModelEventSupport
FIRE_LATER, FIRE_NOW, NO_EVENT
Constructor and Description |
---|
TLcd2DRegularTiledBoundsIndexedModel(ILcdBounds aModelBounds,
ILcdBounded[] aTiles,
ILcdBounds aRegularTileBounds)
Deprecated.
Constructs a new empty
TLcd2DRegularBoundsIndexedModel . |
TLcd2DRegularTiledBoundsIndexedModel(ILcdBounds aModelBounds,
ILcdBounds aRegularRasterBounds,
int aNrTileCols,
int aNrTileRows)
Deprecated.
Constructs a new empty
TLcd2DRegularBoundsIndexedModel ,
initialized with the given model bounds. |
Modifier and Type | Method and Description |
---|---|
void |
addElement(Object aElement,
int aEventMode)
Deprecated.
Adds the specified element to this model.
|
int |
applyOnInteract2DBounds(ILcdBounds aBounds,
boolean aStrictOverlap,
ILcdFunction aFunctionToApply,
double aPrecisionX,
double aPrecisionY)
Deprecated.
Applies the specified function to all the model elements of which the 2D bounds overlap with the specified bounds.
|
int |
applyOnInteract2DBounds(ILcdBounds aBounds,
boolean aStrictOverlap,
ILcdFunction aFunctionToApply,
double aPrecisionX,
double aPrecisionY,
double aMinSizeX,
double aMinSizeY,
boolean aIncludePoints)
Deprecated.
Applies the specified function to all the elements of which the 2D bounds overlap with the specified bounds.
|
boolean |
canAddElement(Object aObject)
Deprecated.
Returns
true if the specified element can be added to this model, false otherwise. |
boolean |
canRemoveElement(Object aObject)
Deprecated.
Returns
true if the specified element can be removed from this model, false otherwise. |
boolean |
contains(Object aObject)
Deprecated.
Returns whether a object is present in this model.
|
Object |
elementAt(int aIndex)
Deprecated.
Returns the element at the specified index.
|
void |
elementChanged(Object aElement,
int aFireEventMode)
Deprecated.
Notifies this model that the specified element has changed.
|
Enumeration |
elements()
Deprecated.
Returns an enumeration over all elements of this model.
|
void |
elementsChanged(Vector aObjects,
int aFireEventMode)
Deprecated.
Notifies this model that the elements in the specified vector have changed.
|
ILcdFilter |
getAddElementFilter()
Deprecated.
Returns the
addElement filter. |
ILcdBounds |
getBounds()
Deprecated.
Returns the
ILcdBounds by which the geometry of this ILcdBounded object
is bounded. |
ILcdFilter |
getRemoveElementFilter()
Deprecated.
Returns the
removeElement filter. |
int |
indexOf(Object aObject)
Deprecated.
Returns the index of the first occurrence of the specified element in the model, or -1 if this model does not
contain the element.
|
static boolean |
isSynchronized()
Deprecated.
Returns whether accessing elements is synchronized.
|
void |
removeAllElements(int aEventMode)
Deprecated.
Removes all elements from this model.
|
void |
removeElement(Object aElement,
int aEventMode)
Deprecated.
Removes the specified element from this model.
|
void |
setAddElementFilter(ILcdFilter aFilter)
Deprecated.
Sets the filter that can filter out elements before they are added.
|
void |
setRemoveElementFilter(ILcdFilter aFilter)
Deprecated.
Sets the filter that can filter out elements before they are removed.
|
static void |
setSynchronized(boolean aSynchronized)
Deprecated.
Specifies whether accessing elements should be synchronized, for backward
compatibility.
|
int |
size()
Deprecated.
Returns the number of elements in this model.
|
addElements, addModelListener, allElementsChanged, allElementsRemoved, dispose, elementAdded, elementRemoved, elementsAdded, elementsRemoved, fireCollectedModelChanges, getModelDescriptor, getModelEncoder, getModelMetadata, getModelReference, initializeTransientValues, isClassTraceOn, isTraceOn, removeElements, removeModelListener, setClassTraceOn, setModelDescriptor, setModelDisposer, setModelEncoder, setModelMetadataFunction, setModelReference, setTraceOn
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
query
addElements, addModelListener, all, dispose, filter, fireCollectedModelChanges, getModelDescriptor, getModelEncoder, getModelMetadata, getModelReference, removeElements, removeModelListener
close
public TLcd2DRegularTiledBoundsIndexedModel(ILcdBounds aModelBounds, ILcdBounded[] aTiles, ILcdBounds aRegularTileBounds)
TLcd2DRegularBoundsIndexedModel
.aModelBounds
- the initial bounds of the model. These bounds
must not be modified by the user after they have
been passed. They should encompass all the
elements the user plans to add to the model,
whether or not they are located in a regular
tile, .aTiles
- the ILcdBounded
that define the
bounds of the regular tiles where the user plans
to add elements into. The tiles should form a
regular raster (all tiles should have the same
dimensions, and should be aligned with each other
in both horizontal and vertical direction), but
the raster should not be completely filled with
tiles. Elements that are added to this model,
whose bounds do not fit into one of the given
tile bounds (whether because they are outside the
regular raster, or inside the raster but located
on a place were no tile exists, or covering
multiple tiles) will be added to the default
tile, covering the given aModelBounds
.aRegularTileBounds
- the ILcdBounds
which width and
height define a regular tile.
Note: passing irregular tiles (whether unaligned
or of different sizes), could result in wrong
results when using the applyOnInteract2DBounds
methods.public TLcd2DRegularTiledBoundsIndexedModel(ILcdBounds aModelBounds, ILcdBounds aRegularRasterBounds, int aNrTileCols, int aNrTileRows)
TLcd2DRegularBoundsIndexedModel
,
initialized with the given model bounds. A regular raster of tiles is
created within the model, based on the given raster bounds and the given
number of tile rows and columns.aModelBounds
- the initial bounds of the model. These bounds must not
be modified by the user after they have been passed.
They should encompass all the elements, whether or not
located in a regular tile, the user plans to add to the
model.aRegularRasterBounds
- the bounds that define the regular raster.aNrTileCols
- the number of columns to be created in the regular raster.aNrTileRows
- the number of rows to be created in the regular raster.public static void setSynchronized(boolean aSynchronized)
false
.public static boolean isSynchronized()
public int applyOnInteract2DBounds(ILcdBounds aBounds, boolean aStrictOverlap, ILcdFunction aFunctionToApply, double aPrecisionX, double aPrecisionY)
ILcd2DBoundsIndexedModel
false
.applyOnInteract2DBounds
in interface ILcd2DBoundsIndexedModel
aBounds
- the rectangle to test overlap with.aStrictOverlap
- 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 aStrictOverlap, 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.aStrictOverlap
- 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.public void setAddElementFilter(ILcdFilter aFilter)
aFilter
- the filter.addElement(java.lang.Object, int)
,
getAddElementFilter()
public ILcdFilter getAddElementFilter()
addElement
filter.addElement
filter.setAddElementFilter(com.luciad.util.ILcdFilter)
public void setRemoveElementFilter(ILcdFilter aFilter)
aFilter
- the filter.removeElement(java.lang.Object, int)
,
getRemoveElementFilter()
public ILcdFilter getRemoveElementFilter()
removeElement
filter.removeElement
filter.setRemoveElementFilter(com.luciad.util.ILcdFilter)
public boolean canAddElement(Object aObject)
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 class ALcdModel
aObject
- 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 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 boolean canRemoveElement(Object aObject)
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 class ALcdModel
aObject
- 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 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 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 class ALcdModel
aEventMode
- the mode for sending out the model change event. This can be FIRE_LATER
or NO_EVENT
.public void elementsChanged(Vector aObjects, int aFireEventMode)
ALcdModel
This implementation calls TLcdModelChangedEventSupport#elementsChanged(java.util.Vector, int)
.
elementsChanged
in interface ILcdModel
elementsChanged
in class ALcdModel
aObjects
- the vector of elements that have changed.aFireEventMode
- the mode for sending out the model change event. This can be FIRE_LATER
or NO_EVENT
.public void elementChanged(Object aElement, int aFireEventMode)
ALcdModel
This implementation calls TLcdModelChangedEventSupport#elementChanged(Object, int)
.
elementChanged
in interface ILcdModel
elementChanged
in class ALcdModel
aElement
- the element that has changed.aFireEventMode
- the mode for sending out the model change event. This can be FIRE_LATER
or NO_EVENT
.public int size()
ILcdIntegerIndexedModel
size
in interface ILcdIntegerIndexedModel
public Enumeration elements()
ILcdModel
public Object elementAt(int aIndex)
ILcdIntegerIndexedModel
elementAt
in interface ILcdIntegerIndexedModel
aIndex
- an index into this ILcdModel
.public int indexOf(Object aObject)
ILcdIntegerIndexedModel
i
for which this.elementAt(i).equals(aElement)
.indexOf
in interface ILcdIntegerIndexedModel
aObject
- the element to search for.public boolean contains(Object aObject)
aObject
- the object for which the check is performed.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.