public class TLcdNVG20Model extends TLcdDataObject implements ILcd2DBoundsIndexedModel, ILcdIntegerIndexedModel, ILcdNVGNode
ILcd2DBoundsIndexedModel
and an ILcdIntegerIndexedModel
. You can access elements by the ILcdModel
interface or with
getGeometry()
.ILcdModel.Query
Modifier and Type | Field and Description |
---|---|
static TLcdDataProperty |
EXTENDED_DATA_PROPERTY
Data property that maps to the
ExtendedData element. |
static TLcdDataProperty |
EXTENSION_PROPERTY
Data property that maps to the
extension element. |
static TLcdDataProperty |
GEOMETRY_PROPERTY
Data property that maps to the choice between the
g and composite and text and point and multipoint and circle and ellipse and rect and polyline and arrow and corridor and orbit and polygon and arc and arcband and content-item elements. |
static TLcdDataProperty |
METADATA_PROPERTY
Data property that maps to the
metadata element. |
static TLcdDataProperty |
SCHEMA_PROPERTY
Data property that maps to the
Schema element. |
static TLcdDataProperty |
VERSION_PROPERTY
Data property that maps to the
version attribute. |
FIRE_LATER, FIRE_NOW, NO_EVENT
Constructor and Description |
---|
TLcdNVG20Model()
Constructs an NVG model with default settings.
|
TLcdNVG20Model(TLcdDataType aDataType)
Constructs an NVG model for a given data type, with default settings.
|
Modifier and Type | Method and Description |
---|---|
void |
addElement(Object aElement,
int aEventMode)
Adds the specified element to this model.
|
void |
addElements(Vector aElements,
int aFireEventMode)
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 aElement)
Returns
true if the specified element can be added to this model, false otherwise. |
boolean |
canRemoveElement(Object aElement)
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.
|
Object |
elementAt(int aIndex)
Returns the element at the specified index.
|
void |
elementChanged(Object aElement,
int aFireEventMode)
Notifies this model that the specified element has changed.
|
Enumeration |
elements()
Returns an enumeration over all elements of this model.
|
void |
elementsChanged(Vector aElements,
int aFireEventMode)
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. |
TLcdNVG20ExtendedData |
getExtendedData()
Returns the value of the property that maps to the
ExtendedData element. |
TLcdNVG20Extension |
getExtension()
Returns the value of the property that maps to the
extension element. |
List<Object> |
getGeometry()
Returns the value of the property that maps to the choice between the
g and composite and text and point and multipoint and circle and ellipse and rect and polyline and arrow and corridor and orbit and polygon and arc and arcband and content-item elements. |
TLcdNVG20Extension |
getMetadata()
Returns the value of the property that maps to the
metadata element. |
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. |
TLcdModelMetadata |
getModelMetadata()
Collects and returns metadata about the model.
|
ILcdModelReference |
getModelReference()
Returns the
ILcdModelReference describing how the geometry of the elements contained in this
model should be interpreted. |
ILcdNVGNode |
getParent()
Get the parent of this object.
|
List<TLcdNVG20Schema> |
getSchema()
Returns the value of the property that maps to the
Schema element. |
String |
getVersion()
Returns the value of the property that maps to the
version attribute. |
int |
indexOf(Object aElement)
Returns the index of the first occurrence of the specified element in the model, or -1 if this model does not
contain the element.
|
void |
invalidate()
Indicates that the model was modified through other means than the methods on
ILcdModel . |
void |
removeAllElements(int aEventMode)
Removes all elements from this model.
|
void |
removeElement(Object aElement,
int aEventMode)
Removes the specified element from this model.
|
void |
removeElements(Vector aElements,
int aFireEventMode)
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 |
setExtendedData(TLcdNVG20ExtendedData aValue)
Sets the value of the property that maps to the
ExtendedData element. |
void |
setExtension(TLcdNVG20Extension aValue)
Sets the value of the property that maps to the
extension element. |
void |
setMetadata(TLcdNVG20Extension aValue)
Sets the value of the property that maps to the
metadata element. |
void |
setModelDescriptor(TLcdNVG20ModelDescriptor aModelDescriptor)
Sets the model descriptor of this model, given the name of the data source.
|
void |
setParent(ILcdNVGNode aParent)
Set the parent of this object to the given parent.
|
void |
setVersion(String aValue)
Sets the value of the property that maps to the
version attribute. |
int |
size()
Returns the number of elements in this model.
|
clone, clone, getDataType, getValue, getValue, hasValue, hasValue, setValue, setValue, toString
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
query
close
public static final TLcdDataProperty VERSION_PROPERTY
version
attribute.
The possible values for this property are instances of String
.public static final TLcdDataProperty SCHEMA_PROPERTY
Schema
element.
The possible values for this property are instances of List<TLcdNVG20Schema>
.public static final TLcdDataProperty METADATA_PROPERTY
metadata
element.
The possible values for this property are instances of TLcdNVG20Extension
.public static final TLcdDataProperty EXTENDED_DATA_PROPERTY
ExtendedData
element.
The possible values for this property are instances of TLcdNVG20ExtendedData
.public static final TLcdDataProperty GEOMETRY_PROPERTY
g
and composite
and text
and point
and multipoint
and circle
and ellipse
and rect
and polyline
and arrow
and corridor
and orbit
and polygon
and arc
and arcband
and content-item
elements.
The possible values for this property are instances of java.util.List
with elements of class
public static final TLcdDataProperty EXTENSION_PROPERTY
extension
element.
The possible values for this property are instances of TLcdNVG20Extension
.public TLcdNVG20Model()
public TLcdNVG20Model(TLcdDataType aDataType)
aDataType
- The type for which to create a new NVG model.public ILcdModelReference getModelReference()
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()
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()
encoder.canEncode(this)
), null
otherwise.getModelEncoder
in interface ILcdModel
null
otherwise.public int applyOnInteract2DBounds(ILcdBounds aBounds, boolean aStrictInteract, ILcdFunction aFunctionToApply, double aPrecisionX, double aPrecisionY)
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)
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.public int size()
size
in interface ILcdIntegerIndexedModel
public Object elementAt(int aIndex)
elementAt
in interface ILcdIntegerIndexedModel
aIndex
- an index into this ILcdModel
.public int indexOf(Object aElement)
i
for which this.elementAt(i).equals(aElement)
.indexOf
in interface ILcdIntegerIndexedModel
aElement
- the element to search for.public Enumeration elements()
public ILcdBounds getBounds()
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 void dispose()
finalize
) on this model subsequent to a call to
this method is undefined.dispose
in interface ILcdModel
dispose
in interface ILcdDisposable
public void removeModelListener(ILcdModelListener aModelListener)
removeModelListener
in interface ILcdModel
aModelListener
- the ILcdModelListener
to remove.ILcdModel.addModelListener(com.luciad.model.ILcdModelListener)
,
ILcdModelListener
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.
addModelListener
in interface ILcdModel
aModelListener
- the ILcdModelListener
to register on this model.ILcdModel.removeModelListener(com.luciad.model.ILcdModelListener)
,
ILcdModelListener
public void elementChanged(Object aElement, int aFireEventMode)
elementChanged
in interface ILcdModel
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 void elementsChanged(Vector aElements, int aFireEventMode)
elementsChanged
in interface ILcdModel
aElements
- 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 fireCollectedModelChanges()
fireCollectedModelChanges
in interface ILcdModel
ILcdModelListener.modelChanged(TLcdModelChangedEvent)
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.
removeAllElements
in interface ILcdModel
aEventMode
- the mode for sending out the model change event. This can be FIRE_LATER
or NO_EVENT
.public boolean canAddElement(Object aElement)
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.
canAddElement
in interface ILcdModel
aElement
- the element to be verified.true
if the specified element can be added to this model, false
otherwise.public boolean canRemoveElement(Object aElement)
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.canRemoveElement
in interface ILcdModel
aElement
- the element to be verified.true
if the specified element can be removed from this model, false
otherwise.public void removeElements(Vector aElements, int aFireEventMode)
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.
removeElements
in interface ILcdModel
aElements
- the vector of elements to be removed from this model.aFireEventMode
- the mode for sending out the model change event. This can be FIRE_LATER
or NO_EVENT
.ILcdModel.canRemoveElement(Object)
public void removeElement(Object aElement, 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.
removeElement
in interface ILcdModel
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 addElements(Vector aElements, int aFireEventMode)
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.
addElements
in interface ILcdModel
aElements
- the vector of elements to be added to this model.aFireEventMode
- the mode for sending the model change events This can be FIRE_LATER
or NO_EVENT
.ILcdModel.canAddElement(Object)
public void addElement(Object aElement, 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.
addElement
in interface ILcdModel
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 void setModelDescriptor(TLcdNVG20ModelDescriptor aModelDescriptor)
aModelDescriptor
- The NVG model descriptor to set to this model.public TLcdModelMetadata getModelMetadata()
ILcdModel
TLcdModelMetadata
instance every time it is called.
The default implementation uses TLcdModelMetadata.Builder.fromModel(com.luciad.model.ILcdModel)
.
Implementations can recreate
or extend
the metadata.
The following example adds a data category and source file mime type:
public TLcdModelMetadata getModelMetadata() {
String source = this.getModelDescriptor().getSourceName();
return this.getModelMetadata().asBuilder()
.entryPoint(new TLcdModelMetadata.Source(source, MIME_XML))
.addDataCategory(TLcdModelMetadata.DataCategory.VECTOR)
.build();
}
getModelMetadata
in interface ILcdModel
public void invalidate()
public ILcdNVGNode getParent()
ILcdNVGNode
getParent
in interface ILcdNVGNode
public void setParent(ILcdNVGNode aParent)
ILcdNVGNode
setParent
in interface ILcdNVGNode
aParent
- The parent to be set to this object.public String getVersion()
version
attribute.
NVG Document Format version identifier.
VERSION_PROPERTY
property.public void setVersion(String aValue)
version
attribute.
NVG Document Format version identifier.
aValue
- the value to set for the VERSION_PROPERTY
property.public List<TLcdNVG20Schema> getSchema()
Schema
element.SCHEMA_PROPERTY
property.public TLcdNVG20Extension getMetadata()
metadata
element.
named container for NDMS / Dublin Core defined metadata
METADATA_PROPERTY
property.public void setMetadata(TLcdNVG20Extension aValue)
metadata
element.
named container for NDMS / Dublin Core defined metadata
aValue
- the value to set for the METADATA_PROPERTY
property.public TLcdNVG20ExtendedData getExtendedData()
ExtendedData
element.EXTENDED_DATA_PROPERTY
property.public void setExtendedData(TLcdNVG20ExtendedData aValue)
ExtendedData
element.aValue
- the value to set for the EXTENDED_DATA_PROPERTY
property.public List<Object> getGeometry()
g
and composite
and text
and point
and multipoint
and circle
and ellipse
and rect
and polyline
and arrow
and corridor
and orbit
and polygon
and arc
and arcband
and content-item
elements.
The possible values for this property are instances of java.util.List
with elements of class
GEOMETRY_PROPERTY
property.public TLcdNVG20Extension getExtension()
extension
element.
Extension point for structured community of interest specific content.
EXTENSION_PROPERTY
property.public void setExtension(TLcdNVG20Extension aValue)
extension
element.
Extension point for structured community of interest specific content.
aValue
- the value to set for the EXTENSION_PROPERTY
property.