com.luciad.model

LuciadFusionClass TLcdTiled2DBoundsIndexedModel

java.lang.Object

com.luciad.model.TLcdTiled2DBoundsIndexedModel

All Implemented Interfaces:

ILcd2DBoundsIndexedModel, ILcd2DBoundsInteractable, ILcdModel, ILcdBounded, ILcdDisposable, Serializable, AutoCloseable

Deprecated.

This API is only here to support deprecated formats.

@Deprecated
public class TLcdTiled2DBoundsIndexedModel
extends Object
implements ILcd2DBoundsIndexedModel

An implementation of 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 read-only model. It is thread-safe for accessing its submodels.

See Also:

Serialized Form

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

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addElement(Object aObject, int aEventMode) Deprecated. Adds the specified element to this model.
void	addElements(Vector aObjects, int aEventMode) Deprecated. Adds all of the elements in the specified vector to this model.
void	addModel(ILcd2DBoundsIndexedModel aModel, int aFireEventMode) Deprecated. Adds a submodel to this model.
void	addModelListener(ILcdModelListener aModelListener) Deprecated. 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) 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 aStrictInteract, 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.
void	dispose() Deprecated. Disposes of this model and allows it to release any system resources that it is holding.
void	elementChanged(Object aObject, int aEventMode) 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 aEventMode) Deprecated. Notifies this model that the elements in the specified vector have changed.
void	fireCollectedModelChanges() Deprecated. 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() Deprecated. Returns the ILcdBounds by which the geometry of this ILcdBounded object is bounded.
ILcdModelDescriptor	getModelDescriptor() Deprecated. Returns the ILcdModelDescriptor providing meta information about this model and its elements.
ILcdModelEncoder	getModelEncoder() Deprecated. Returns, if available, a model encoder that is capable of encoding this model, (encoder.canEncode(this)), null otherwise.
ILcdModelReference	getModelReference() Deprecated. Returns the ILcdModelReference describing how the geometry of the elements contained in this model should be interpreted.
Enumeration	models() Deprecated. Returns an enumeration of all the submodels contained in this model.
void	removeAllElements(int aEventMode) Deprecated. Removes all elements from this model.
void	removeElement(Object aObject, int aEventMode) Deprecated. Removes the specified element from this model.
void	removeElements(Vector aObjects, int aEventMode) Deprecated. Removes all of the elements in the specified vector from this model.
void	removeModel(ILcd2DBoundsIndexedModel aModel, int aFireEventMode) Deprecated. Removes a submodel from this model.
void	removeModelListener(ILcdModelListener aModelListener) Deprecated. Unregisters the specified model listener so that it no longer receives notifications of model changes on this model.
void	setModelDescriptor(ILcdModelDescriptor aModelDescriptor) Deprecated. Sets the model descriptor providing meta information about this model and its elements.
void	setModelReference(ILcdModelReference aModelReference) Deprecated. Sets the model reference describing how the geometry of the elements contained in this model should be interpreted.

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.model.ILcdModel

all, filter, getModelMetadata

Methods inherited from interface com.luciad.util.ILcdDisposable

close

Constructor Detail

TLcdTiled2DBoundsIndexedModel

public TLcdTiled2DBoundsIndexedModel()

Deprecated.

Constructs a new, empty TLcdTiled2DBoundsIndexedModel.

TLcdTiled2DBoundsIndexedModel

public TLcdTiled2DBoundsIndexedModel(ILcdBounds aModelBounds)

Deprecated.

Constructs a new, empty TLcdTiled2DBoundsIndexedModel, initialized with the specified initial bounds.

Parameters:

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.

TLcdTiled2DBoundsIndexedModel

public TLcdTiled2DBoundsIndexedModel(ILcd2DBoundsIndexedModel a2DBoundsIndexedModel)

Deprecated.

Constructs a new TLcdTiled2DBoundsIndexedModel, initialized with the specified model. The specified model should either be empty or contain ILcd2DBoundsIndexedModel objects as elements.

Parameters:

a2DBoundsIndexedModel - the spatially indexed model that will be used to store the submodels of this model.

Method Detail

setModelReference

public void setModelReference(ILcdModelReference aModelReference)

Deprecated.

Sets the model reference describing how the geometry of the elements contained in this model should be interpreted.

Parameters:

aModelReference - the model reference for this model.

See Also:

getModelReference()

setModelDescriptor

public void setModelDescriptor(ILcdModelDescriptor aModelDescriptor)

Deprecated.

Sets the model descriptor providing meta information about this model and its elements.

Parameters:

aModelDescriptor - the model descriptor for this model.

See Also:

getModelDescriptor()

addModel

public void addModel(ILcd2DBoundsIndexedModel aModel,
                     int aFireEventMode)

Deprecated.

Adds a submodel to this model.

Parameters:

aModel - the submodel to be added to this model.

aFireEventMode - the mode for sending out the TLcdModelChangedEvent.

removeModel

public void removeModel(ILcd2DBoundsIndexedModel aModel,
                        int aFireEventMode)

Deprecated.

Removes a submodel from this model.

Parameters:

aModel - the submodel to be removed from this model.

aFireEventMode - the mode for sending out the TLcdModelChangedEvent.

models

public Enumeration models()

Deprecated.

Returns an enumeration of all the submodels contained in this model.

Returns:

an enumeration of all the submodels contained in this model.

See Also:

addModel(ILcd2DBoundsIndexedModel, int)

getModelReference

public ILcdModelReference getModelReference()

Deprecated.

Returns the 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.

Specified by:

getModelReference in interface ILcdModel

Returns:

the ILcdModelReference of this ILcdModel.

getModelDescriptor

public ILcdModelDescriptor getModelDescriptor()

Deprecated.

Returns the 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.

Specified by:

getModelDescriptor in interface ILcdModel

Returns:

the ILcdModelDescriptor of this ILcdModel. Should not be null.

getModelEncoder

public ILcdModelEncoder getModelEncoder()

Deprecated.

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 interface ILcdModel

Returns:

a model encoder that is capable of encoding this model if available, null otherwise.

elements

public Enumeration elements()

Deprecated.

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.

Specified by:

elements in interface ILcdModel

Returns:

an enumeration over all elements of this model.

addElement

public void addElement(Object aObject,
                       int aEventMode)

Deprecated.

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 interface ILcdModel

Parameters:

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.

See Also:

ILcdModel.canAddElement(Object)

canAddElement

public boolean canAddElement(Object aObject)

Deprecated.

Returns 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).

Specified by:

canAddElement in interface ILcdModel

Parameters:

aObject - the element to be verified.

Returns:

true if the specified element can be added to this model, false otherwise.

addElements

public void addElements(Vector aObjects,
                        int aEventMode)

Deprecated.

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 implement 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).

Specified by:

addElements in interface ILcdModel

Parameters:

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.

See Also:

ILcdModel.canAddElement(Object)

removeElement

public void removeElement(Object aObject,
                          int aEventMode)

Deprecated.

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 interface ILcdModel

Parameters:

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.

See Also:

ILcdModel.canRemoveElement(Object)

canRemoveElement

public boolean canRemoveElement(Object aObject)

Deprecated.

Returns 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).

Specified by:

canRemoveElement in interface ILcdModel

Parameters:

aObject - the element to be verified.

Returns:

true if the specified element can be removed from this model, false otherwise.

removeElements

public void removeElements(Vector aObjects,
                           int aEventMode)

Deprecated.

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 interface ILcdModel

Parameters:

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.

See Also:

ILcdModel.canRemoveElement(Object)

removeAllElements

public void removeAllElements(int aEventMode)

Deprecated.

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 interface ILcdModel

Parameters:

aEventMode - the mode for sending out the model change event. This can be FIRE_LATER or NO_EVENT.

elementChanged

public void elementChanged(Object aObject,
                           int aEventMode)

Deprecated.

Notifies this model that the specified element has changed.

This implementation always throws an IllegalArgumentException (this model is not editable).

Specified by:

elementChanged in interface ILcdModel

Parameters:

aObject - the element that has changed.

aEventMode - the mode for sending out the model change event. This can be FIRE_LATER or NO_EVENT.

elementsChanged

public void elementsChanged(Vector aObjects,
                            int aEventMode)

Deprecated.

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 interface ILcdModel

Parameters:

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.

fireCollectedModelChanges

public void fireCollectedModelChanges()

Deprecated.

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 interface ILcdModel

See Also:

ILcdModelListener.modelChanged(TLcdModelChangedEvent)

addModelListener

public void addModelListener(ILcdModelListener aModelListener)

Deprecated.

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).

Specified by:

addModelListener in interface ILcdModel

Parameters:

aModelListener - the ILcdModelListener to register on this model.

See Also:

ILcdModel.removeModelListener(com.luciad.model.ILcdModelListener), ILcdModelListener

removeModelListener

public void removeModelListener(ILcdModelListener aModelListener)

Deprecated.

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 interface ILcdModel

Parameters:

aModelListener - the ILcdModelListener to remove.

See Also:

ILcdModel.addModelListener(com.luciad.model.ILcdModelListener), ILcdModelListener

dispose

public void dispose()

Deprecated.

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 than finalize) on this model subsequent to a call to this method is undefined.

Specified by:

dispose in interface ILcdModel

Specified by:

dispose in interface ILcdDisposable

getBounds

public ILcdBounds getBounds()

Deprecated.

Description copied from interface: ILcdBounded

Returns the 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.

Specified by:

getBounds in interface ILcdBounded

Returns:

the ILcdBounds by which the geometry of this ILcdBounded object is bounded.

applyOnInteract2DBounds

public int applyOnInteract2DBounds(ILcdBounds aBounds,
                                   boolean aStrictInteract,
                                   ILcdFunction aFunctionToApply,
                                   double aPrecisionX,
                                   double aPrecisionY)

Deprecated.

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 interface ILcd2DBoundsIndexedModel

Parameters:

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.

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)

Deprecated.

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 interface ILcd2DBoundsIndexedModel

Specified by:

applyOnInteract2DBounds in interface ILcd2DBoundsInteractable

Parameters:

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.

Returns:

the number of elements to which the ILcdFunction has been applied.