Package com.luciad.format.nvg.nvg15.model

Class TLcdNVG15Model

java.lang.Object
com.luciad.datamodel.TLcdDataObject
com.luciad.format.nvg.nvg15.model.TLcdNVG15Model
All Implemented Interfaces:
ILcdDataObject, ILcdNVGNode, ILcd2DBoundsIndexedModel, ILcd2DBoundsInteractable, ILcdIntegerIndexedModel, ILcdModel, ILcdBounded, ILcdCloneable, ILcdDeepCloneable, ILcdDisposable, Serializable, AutoCloseable, Cloneable
public class TLcdNVG15Model extends TLcdDataObject implements ILcd2DBoundsIndexedModel, ILcdIntegerIndexedModel, ILcdNVGNode
Implementation of the root of a NATO Vector Graphics 1.4/1.5 document that is also an an ILcd2DBoundsIndexedModel and an ILcdIntegerIndexedModel. You can access elements by the ILcdModel interface or with getGeometry().
Since:
2015.0
See Also:

  • Field Details

  • Constructor Details

    • TLcdNVG15Model

      public TLcdNVG15Model()
      Constructs an NVG model with default settings.

    • TLcdNVG15Model

      public TLcdNVG15Model(TLcdDataType aDataType)
      Constructs an NVG model for a given data type, with default settings.
      Parameters:
      aDataType - The type for which to create a new NVG model.

  • Method Details

    • getModelReference

      public ILcdModelReference getModelReference()
      Returns the ILcdModelReference describing how the geometry of the elements contained in this model should be interpreted.
      Specified by:
      getModelReference in interface ILcdModel
      Returns:
      the ILcdModelReference of this ILcdModel.

    • getModelDescriptor

      public ILcdModelDescriptor getModelDescriptor()
      Returns the ILcdModelDescriptor providing meta information about this model and its elements.
      Specified by:
      getModelDescriptor in interface ILcdModel
      Returns:
      the ILcdModelDescriptor of this ILcdModel. Should not be null.

    • getModelEncoder

      public ILcdModelEncoder getModelEncoder()
      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.

    • getModelMetadata

      public TLcdModelMetadata getModelMetadata()
      Description copied from interface: ILcdModel
      Collects and returns metadata about the model. Note that this method does not necessarily return the same 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();
   }
      Specified by:
      getModelMetadata in interface ILcdModel
      Returns:
      Metadata about the model.

    • applyOnInteract2DBounds

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

    • size

      public int size()
      Returns the number of elements in this model.
      Specified by:
      size in interface ILcdIntegerIndexedModel
      Returns:
      the number of elements in this model.

    • elementAt

      public Object elementAt(int aIndex)
      Returns the element at the specified index.
      Specified by:
      elementAt in interface ILcdIntegerIndexedModel
      Parameters:
      aIndex - an index into this ILcdModel.
      Returns:
      the element at the specified index.

    • indexOf

      public 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. More formally: returns the smallest i for which this.elementAt(i).equals(aElement).
      Specified by:
      indexOf in interface ILcdIntegerIndexedModel
      Parameters:
      aElement - the element to search for.
      Returns:
      the index of the first occurrence of the specified element in model vector, or -1 if this model does not contain the element.

    • elements

      public Enumeration elements()
      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.

    • getBounds

      public ILcdBounds getBounds()
      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.

    • dispose

      public void dispose()
      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 ILcdDisposable
      Specified by:
      dispose in interface ILcdModel

    • removeModelListener

      public void removeModelListener(ILcdModelListener aModelListener)
      Unregisters the specified model listener so that it no longer receives notifications of model changes on this model.
      Specified by:
      removeModelListener in interface ILcdModel
      Parameters:
      aModelListener - the ILcdModelListener to remove.
      See Also:

    • addModelListener

      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.

      Specified by:
      addModelListener in interface ILcdModel
      Parameters:
      aModelListener - the ILcdModelListener to register on this model.
      See Also:

    • elementChanged

      public void elementChanged(Object aElement, int aFireEventMode)
      Notifies this model that the specified element has changed.
      Specified by:
      elementChanged in interface ILcdModel
      Parameters:
      aElement - the element that has changed.
      aFireEventMode - the mode for sending out the model change event. This can be FIRE_LATER or NO_EVENT.

    • elementsChanged

      public void elementsChanged(Vector aElements, int aFireEventMode)
      Notifies this model that the elements in the specified vector have changed.
      Specified by:
      elementsChanged in interface ILcdModel
      Parameters:
      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.

    • 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.
      Specified by:
      fireCollectedModelChanges in interface ILcdModel
      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.

      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.

    • canAddElement

      public boolean canAddElement(Object aElement)
      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.

      Specified by:
      canAddElement in interface ILcdModel
      Parameters:
      aElement - the element to be verified.
      Returns:
      true if the specified element can be added to this model, false otherwise.

    • canRemoveElement

      public boolean canRemoveElement(Object aElement)
      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.
      Specified by:
      canRemoveElement in interface ILcdModel
      Parameters:
      aElement - the element to be verified.
      Returns:
      true if the specified element can be removed from this model, false otherwise.

    • removeElements

      public void removeElements(Vector aElements, int aFireEventMode)
      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.

      Specified by:
      removeElements in interface ILcdModel
      Parameters:
      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.
      See Also:

    • removeElement

      public void removeElement(Object aElement, int aEventMode)
      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.

      Specified by:
      removeElement in interface ILcdModel
      Parameters:
      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.
      See Also:

    • addElements

      public void addElements(Vector aElements, int aFireEventMode)
      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.

      Specified by:
      addElements in interface ILcdModel
      Parameters:
      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.
      See Also:

    • addElement

      public void addElement(Object aElement, int aEventMode)
      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.

      Specified by:
      addElement in interface ILcdModel
      Parameters:
      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.
      See Also:

    • setModelDescriptor

      public void setModelDescriptor(TLcdNVG15ModelDescriptor aModelDescriptor)
      Sets the model descriptor of this model, given the name of the data source.
      Parameters:
      aModelDescriptor - The NVG model descriptor to set to this model.

    • invalidate

      public void invalidate()
      Indicates that the model was modified through other means than the methods on ILcdModel. For example by modifying this model's geometry

    • getParent

      public ILcdNVGNode getParent()
      Description copied from interface: ILcdNVGNode
      Get the parent of this object.
      Specified by:
      getParent in interface ILcdNVGNode
      Returns:
      The parent of this object.

    • setParent

      public void setParent(ILcdNVGNode aParent)
      Description copied from interface: ILcdNVGNode
      Set the parent of this object to the given parent.
      Specified by:
      setParent in interface ILcdNVGNode
      Parameters:
      aParent - The parent to be set to this object.

    • getClassification

      public String getClassification()
      Returns the value of the property that maps to the classification attribute.

      The classification of the data in this NVG section. It is recommended that this String contain at least one of the words unclassified, restricted, confidential or secret.

      Returns:
      the value of the CLASSIFICATION_PROPERTY property.

    • setClassification

      public void setClassification(String aValue)
      Sets the value of the property that maps to the classification attribute.

      The classification of the data in this NVG section. It is recommended that this String contain at least one of the words unclassified, restricted, confidential or secret.

      Parameters:
      aValue - the value to set for the CLASSIFICATION_PROPERTY property.

    • getId

      public QName getId()
      Returns the value of the property that maps to the id attribute.

      A (unique) identifier for this NVG data section.

      Returns:
      the value of the ID_PROPERTY property.

    • setId

      public void setId(QName aValue)
      Sets the value of the property that maps to the id attribute.

      A (unique) identifier for this NVG data section.

      Parameters:
      aValue - the value to set for the ID_PROPERTY property.

    • getVersion

      public String getVersion()
      Returns the value of the property that maps to the version attribute.

      The version of the NVG format of the data in this section.

      Returns:
      the value of the VERSION_PROPERTY property.

    • setVersion

      public void setVersion(String aValue)
      Sets the value of the property that maps to the version attribute.

      The version of the NVG format of the data in this section.

      Parameters:
      aValue - the value to set for the VERSION_PROPERTY property.

    • getGeometry

      public List<Object> getGeometry()
      Returns the value of the property that maps to the choice between the g and a and composite and text and point and circle and ellipse and polyline and corridor and polygon and arc and arcband and multipoint and content-item and arrow elements.

      The possible values for this property are instances of java.util.List with elements of class

      Returns:
      the value of the GEOMETRY_PROPERTY property.

    • getMetadata

      public ILcdDataObject getMetadata()
      Returns the value of the property that maps to the metadata element.
      Returns:
      the value of the METADATA_PROPERTY property.

    • setMetadata

      public void setMetadata(ILcdDataObject aValue)
      Sets the value of the property that maps to the metadata element.
      Parameters:
      aValue - the value to set for the METADATA_PROPERTY property.

    • getExtendedData

      public TLcdNVG15ExtendedData getExtendedData()
      Returns the value of the property that maps to the ExtendedData element.
      Returns:
      the value of the EXTENDED_DATA_PROPERTY property.

    • setExtendedData

      public void setExtendedData(TLcdNVG15ExtendedData aValue)
      Sets the value of the property that maps to the ExtendedData element.
      Parameters:
      aValue - the value to set for the EXTENDED_DATA_PROPERTY property.

    • getSchema

      public TLcdNVG15Schema getSchema()
      Returns the value of the property that maps to the Schema element.
      Returns:
      the value of the SCHEMA_PROPERTY property.

    • setSchema

      public void setSchema(TLcdNVG15Schema aValue)
      Sets the value of the property that maps to the Schema element.
      Parameters:
      aValue - the value to set for the SCHEMA_PROPERTY property.