Package com.luciad.format.kml22.model

Class TLcdKML22RenderableModel

java.lang.Object
com.luciad.model.ALcdModel
com.luciad.format.kml22.model.TLcdKML22RenderableModel
All Implemented Interfaces:
ILcd2DBoundsIndexedModel, ILcd2DBoundsInteractable, ILcdModel, ILcdBounded, ILcdTimeBounded, ILcdDisposable, Serializable, AutoCloseable, ReadWriteLock
public class TLcdKML22RenderableModel extends ALcdModel implements ILcd2DBoundsIndexedModel, ILcdTimeBounded, ReadWriteLock
Wrapper model around TLcdKML22DynamicModel that prepares the model for rendering.

It performs the following steps:

  • It flattens the hierarchical model structure of a KML model. This allows the KML model to be rendered using a single layer.
  • It performs an ordering of the KML content types (placemarks, ground overlays, screen overlays, etc...).
  • A filter time bounds can be set on it to restrict the time period for which elements should be displayed.
  • It will group events in the KML model, to reduce the total number of events that is generated when e.g. a model is updated by a KML Network Link update.

Since:
10.0
See Also:

  • Constructor Details

    • TLcdKML22RenderableModel

      public TLcdKML22RenderableModel(TLcdKML22DynamicModel aDelegateModel)
      Constructs a TLcdKML22Model object based on the given delegate TLcdKML22ModelTreeNode. The generated object will flatten the hierarchy of the ILcdModelTreeNode interface. This constructor will add listeners to the delegate model so that all events in the hierarchy become available as model changed events.

      The created model will be initialized with the following default content type ordering:
      • Ground overlays
      • Placemarks
      • Photo overlays
      • Screen overlays

      Note: Please call the #dispose method to dispose an instance of this class.

      Parameters:
      aDelegateModel - The root node of a TLcdKML22ModelTreeNode hierarchy.

    • TLcdKML22RenderableModel

      public TLcdKML22RenderableModel(TLcdKML22DynamicModel aDelegateModel, List<EnumSet<ELcdKML22ContentType>> aDefaultContentTypeOrder)
      Constructs a TLcdKML22Model object based on the given delegate TLcdKML22ModelTreeNode. The generated object will flatten the hierarchy of the ILcdModelTreeNode interface. This constructor will add listeners to the delegate model so that all events in the hierarchy become available as model changed events.

      Note: Please call the #dispose method to dispose an instance of this class.
      Parameters:
      aDelegateModel - The root node of a TLcdKML22ModelTreeNode hierarchy.
      aDefaultContentTypeOrder - a list with sets of KML content types that specifies in which order the elements of this model should be enumerated when performing an applyOnInteract or elements query.

  • Method Details

    • firePropertyChange

      protected void firePropertyChange(PropertyChangeEvent aPropertyChangeEvent)
      Fires a property change to all registered listeners.
      Parameters:
      aPropertyChangeEvent - a property change event

    • removePropertyChangeListener

      public void removePropertyChangeListener(PropertyChangeListener aListener)
      Removes a property change listener from this model
      Parameters:
      aListener - a property change listener to remove

    • addPropertyChangeListener

      public void addPropertyChangeListener(PropertyChangeListener aListener)
      Registers a property change listener to this model
      Parameters:
      aListener - a property change listener to add to this model

    • getDelegateModel

      public TLcdKML22DynamicModel getDelegateModel()

      Returns the TLcdKML22DynamicModel that this wrapped by this TLcdKML22RenderableModel

      Returns:
      A valid TLcdKML22DynamicModel

    • getDefaultContentTypeOrder

      public List<EnumSet<ELcdKML22ContentType>> getDefaultContentTypeOrder()
      A list of EnumSet instances that each define a grouping of elements. This grouping of elements defines the order in which they should be rendered on the screen.
      Returns:
      A list of EnumSets that each contain one or more ELcdKML22ContentType instances.

    • setDefaultContentTypeOrder

      public void setDefaultContentTypeOrder(List<EnumSet<ELcdKML22ContentType>> aDefaultContentTypeOrder)
      Sets the content type ordering to apply when performing a call to a applyOnInteract or elements method that does not take a content type parameter.
      Parameters:
      aDefaultContentTypeOrder - a list with content types specifying the ordering of the elements to be applied.

    • getDefaultFilterTimeBounds

      public ILcdTimeBounds getDefaultFilterTimeBounds()
      Returns the content type ordering to apply when performing a call to a applyOnInteract or elements method that does not take a content type parameter.
      Returns:
      The list with content types specifying the ordering of the elements to be applied.

    • setDefaultFilterTimeBounds

      public void setDefaultFilterTimeBounds(ILcdTimeBounds aFilterTimeBounds)
      Sets the time bounds to restrict to when performing a call to a applyOnInteract or elements method that does not take a time bounds parameter.
      Parameters:
      aFilterTimeBounds - The timebounds filter for this model, or null if the timebounds should not be filtered.

    • getTimeBounds

      public ILcdTimeBounds getTimeBounds(ILcdBounds aSpatialBounds, Set<ELcdKML22ContentType> aContentTypes, Set<ELcdKML22AltitudeMode> aAltitudeModes, boolean aFilterOnVisibility, boolean aFilterOnRegion, ILcdFilter aElementFilter, boolean aIgnoreUnboundedTimeBounds)
      Returns the union of all time bounds of the elements in the hierarchy of the delegate model that meet the specified filter.
      Parameters:
      aSpatialBounds - the spatial bounds filter - only overlapping elements will be selected.
      aContentTypes - the KML content type filter - only elements with the specified content type will be selected.
      aAltitudeModes - the altitude mode filter - only elements with the specified altitude mode will be selected.
      aFilterOnVisibility - the visibility filter - if true, only the visible element will be selected, otherwise visibility will not be taken into account.
      aFilterOnRegion - region filter - if true, elements in a non-active region filter will not be taken into account.
      aElementFilter - A custom filter that will be applied on each element.
      aIgnoreUnboundedTimeBounds - specifies whether unbounded start or end bounds should be included in the union (if at least one element is unbounded, the union bounds will be unbounded).
      Returns:
      the union of all spatial bounds of the elements in this model that meet the specified filter.

    • getBounds

      public ILcdBounds getBounds(ILcdTimeBounds aTimeBounds, Set<ELcdKML22ContentType> aContentTypes, Set<ELcdKML22AltitudeMode> aAltitudeModes, boolean aFilterOnVisibility, ILcdFilter aElementFilter)
      Returns the union of all spatial bounds of the elements in this model that meet the specified filter.
      Parameters:
      aTimeBounds - the time bounds filter - only overlapping elements will be selected.
      aContentTypes - the KML content type filter - only elements with the specified content type will be selected.
      aAltitudeModes - the altitude mode filter - only elements with the specified altitude mode will be selected.
      aFilterOnVisibility - the visibility filter - if true, only the visible element will be selected, otherwise visibility will not be taken into account.
      aElementFilter - a custom element filter to filter out certain elements from the bounds calculation
      Returns:
      the union of all spatial bounds of the elements in this model that meet the specified filter.

    • applyOnInteract2DBounds

      public int applyOnInteract2DBounds(ILcdBounds aBounds, ILcdTimeBounds aTimeBounds, Set<ELcdKML22ContentType> aContentTypes, Set<ELcdKML22AltitudeMode> aFilterOnAltitudeModes, boolean aFilterOnVisibility, boolean aFilterOnRegion, boolean aForceDrawingOrder, boolean aStrictInteract, ILcdFunction aFunctionToApply, double aPrecisionX, double aPrecisionY)
      Applies the specified function to all the model elements that meet the specified filter. By default, the order in which the function is applied on the elements is unspecified and depends on the implementation.

      A filter can be specified on the following properties:

      • Spatial bounds
      • Time bounds
      • KML content type
      • Visibility

      The return value of the specified function is used as a stop criterion: the spatial query is interrupted if the function returns false.

      Parameters:
      aBounds - the spatial bounds filter - only overlapping elements will be selected.
      aTimeBounds - the time bounds filter - only overlapping elements will be selected.
      aContentTypes - the KML content type filter - only elements with the specified content type will be selected.
      aFilterOnAltitudeModes - the altitude mode filter - only elements with the specified altitude mode will be selected.
      aFilterOnVisibility - the visibility filter - if true, only the visible element will be selected, otherwise visibility will not be taken into account.
      aFilterOnRegion - the region filter - if true only region active elements will be selected, otherwise region activity will not be taken into account.
      aForceDrawingOrder - indicates whether the drawing order of overlays should be taken into account. If true, objects with a drawing order will be applied after all other objects, and objects with a higher drawing order will be applied after objects with a lower drawing order.
      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.
      aPrecisionY - the precision required in the y dimension, expressed in model units.
      Returns:
      the number of elements to which the ILcdFunction has been applied.
      Throws:
      NullPointerException - if the specified bounds or the specified function are null.

    • applyOnInteract2DBounds

      public int applyOnInteract2DBounds(ILcdBounds aBounds, ILcdTimeBounds aTimeBounds, Set<ELcdKML22ContentType> aContentTypes, Set<ELcdKML22AltitudeMode> aFilterOnAltitudeModes, boolean aFilterOnVisibility, boolean aFilterOnRegion, boolean aForceDrawingOrder, boolean aStrictInteract, ILcdFunction aFunctionToApply, double aPrecisionX, double aPrecisionY, double aMinSizeX, double aMinSizeY, boolean aIncludePoints)
      Applies the specified function to all the model elements that meet the specified filter. The order in which the function is applied on the elements is unspecified and depends on the implementation.

      A filter can be specified on the following properties:

      • Spatial bounds
      • Time bounds
      • KML content type
      • Visibility

      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.

      Parameters:
      aBounds - the spatial bounds filter - only overlapping elements will be selected.
      aTimeBounds - the time bounds filter - only overlapping elements will be selected.
      aContentTypes - the KML content type filter - only elements with the specified content type will be selected.
      aFilterOnAltitudeModes - the altitude mode filter - only elements with the specified altitude mode will be selected.
      aFilterOnVisibility - the visibility filter - if true, only the visible element will be selected, otherwise visibility will not be taken into account.
      aFilterOnRegion - the region filter - if true only region active elements will be selected, otherwise region activity will not be taken into account.
      aForceDrawingOrder - indicates whether the drawing order of overlays should be taken into account. If true, objects with a drawing order will be applied after all other objects, and objects with a higher drawing order will be applied after objects with a lower drawing order.
      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.
      aPrecisionY - the precision required in the y dimension, expressed in model units.
      aMinSizeX - the minimal element size in the x dimension, expressed in model units.
      aMinSizeY - the minimal element size in the y dimension, 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.
      Throws:
      NullPointerException - if the specified bounds or the specified function are null.

    • elements

      public Enumeration elements(ILcdBounds aBounds, ILcdTimeBounds aTimeBounds, Set<ELcdKML22ContentType> aContentTypes, Set<ELcdKML22AltitudeMode> aAltitudeModes, boolean aFilterOnVisibility, boolean aFilterOnRegion, boolean aForceDrawingOrder)
      Returns an enumeration over all elements of this model that meet the specified filter.

      The order in which the elements are enumerated is unspecified by default.

      A filter can be specified on the following properties:

      • Spatial bounds
      • Time bounds
      • KML content type
      • Visibility
      Parameters:
      aBounds - the spatial bounds filter - only overlapping elements will be selected.
      aTimeBounds - the time bounds filter - only overlapping elements will be selected.
      aContentTypes - the KML content type filter - only elements with the specified content type will be selected.
      aAltitudeModes - the altitude mode filter - only elements with the specified altitude mode will be selected.
      aFilterOnVisibility - the visibility filter - if true, only the visible element will be selected, otherwise visibility will not be taken into account.
      aFilterOnRegion - region filter - if true, elements in a non-active region filter will be skipped.
      aForceDrawingOrder - indicates whether the drawing order of overlays should be taken into account. If true, objects with a drawing order will be applied after all other objects, and objects with a higher drawing order will be applied after objects with a lower drawing order.
      Returns:
      an enumeration over all elements of this model.

    • getTimeBounds

      public ILcdTimeBounds getTimeBounds()
      Description copied from interface: ILcdTimeBounded
      Returns the ILcdTimeBounds by which this object is bounded.
      Specified by:
      getTimeBounds in interface ILcdTimeBounded
      Returns:
      the ILcdTimeBounds by which this object is bounded.

    • applyOnInteract2DBounds

      public int applyOnInteract2DBounds(ILcdBounds aBounds, boolean aStrictInteract, ILcdFunction aFunctionToApply, double aPrecisionX, double aPrecisionY)
      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)
      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.

    • elements

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

    • dispose

      public void dispose()
      Description copied from class: ALcdModel
      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.

      When a model disposer has been provided it is called, otherwise this method does nothing. When overriding this method it is recommended to call super.dispose().

      Specified by:
      dispose in interface ILcdDisposable
      Specified by:
      dispose in interface ILcdModel
      See Also:

    • addModelListener

      public void addModelListener(ILcdModelListener aModelListener)
      Description copied from class: ALcdModel

      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 calls TLcdModelChangedEventSupport#addModelListener(ILcdModelListener).

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

    • removeModelListener

      public void removeModelListener(ILcdModelListener aModelListener)
      Description copied from class: ALcdModel
      Unregisters the specified model listener so that it no longer receives notifications of model changes on this model.

      This implementation calls TLcdModelChangedEventSupport#removeModelListener(ILcdModelListener).

      Specified by:
      removeModelListener in interface ILcdModel
      Overrides:
      removeModelListener in class ALcdModel
      Parameters:
      aModelListener - the ILcdModelListener to remove.
      See Also:

    • getBounds

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

    • readLock

      public Lock readLock()
      Specified by:
      readLock in interface ReadWriteLock

    • writeLock

      public Lock writeLock()
      Specified by:
      writeLock in interface ReadWriteLock

    • getModelDescriptor

      public ILcdModelDescriptor getModelDescriptor()
      Description copied from class: ALcdModel
      Returns the ILcdModelDescriptor providing meta information about this model and its elements.
      Specified by:
      getModelDescriptor in interface ILcdModel
      Overrides:
      getModelDescriptor in class ALcdModel
      Returns:
      the ILcdModelDescriptor of this ILcdModel. Should not be null.
      See Also:

    • getModelReference

      public ILcdModelReference getModelReference()
      Description copied from class: ALcdModel
      Returns the ILcdModelReference describing how the geometry of the elements contained in this model should be interpreted.
      Specified by:
      getModelReference in interface ILcdModel
      Overrides:
      getModelReference in class ALcdModel
      Returns:
      the ILcdModelReference of this ILcdModel.
      See Also:

    • getModelEncoder

      public ILcdModelEncoder getModelEncoder()
      Description copied from class: ALcdModel
      Returns, if available, a model encoder that is capable of encoding this model, (encoder.canEncode(this)), null otherwise.
      Specified by:
      getModelEncoder in interface ILcdModel
      Overrides:
      getModelEncoder in class ALcdModel
      Returns:
      a model encoder that is capable of encoding this model if available, null otherwise.
      See Also:

    • canAddElement

      public boolean canAddElement(Object aElement)
      Description copied from class: ALcdModel
      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.

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

    • addElement

      public void addElement(Object aElement, int aEventMode)
      Description copied from class: ALcdModel
      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 UnsupportedOperationException.

      Specified by:
      addElement in interface ILcdModel
      Overrides:
      addElement in class ALcdModel
      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:

    • addElements

      public void addElements(Vector aElements, int aEventMode)
      Description copied from class: ALcdModel
      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 iterates over all elements in the specified vector, and calls addElement(Object, int) for each element to be added, 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.

      Specified by:
      addElements in interface ILcdModel
      Overrides:
      addElements in class ALcdModel
      Parameters:
      aElements - 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:

    • canRemoveElement

      public boolean canRemoveElement(Object aElement)
      Description copied from class: ALcdModel
      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.

      Specified by:
      canRemoveElement in interface ILcdModel
      Overrides:
      canRemoveElement in class ALcdModel
      Parameters:
      aElement - the element to be verified.
      Returns:
      true if the specified element can be removed from this model, false otherwise.

    • removeElement

      public void removeElement(Object aElement, int aEventMode)
      Description copied from class: ALcdModel
      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 UnsupportedOperationException.

      Specified by:
      removeElement in interface ILcdModel
      Overrides:
      removeElement in class ALcdModel
      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:

    • removeElements

      public void removeElements(Vector aElements, int aEventMode)
      Description copied from class: ALcdModel
      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 iterates over all elements in the specified vector, 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.

      Specified by:
      removeElements in interface ILcdModel
      Overrides:
      removeElements in class ALcdModel
      Parameters:
      aElements - 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:

    • removeAllElements

      public void removeAllElements(int aEventMode)
      Description copied from class: ALcdModel
      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 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.

      Specified by:
      removeAllElements in interface ILcdModel
      Overrides:
      removeAllElements in class ALcdModel
      Parameters:
      aEventMode - the mode for sending out the model change event. This can be FIRE_LATER or NO_EVENT.

    • elementChanged

      public void elementChanged(Object aElement, int aEventMode)
      Description copied from class: ALcdModel
      Notifies this model that the specified element has changed.

      This implementation calls TLcdModelChangedEventSupport#elementChanged(Object, int).

      Specified by:
      elementChanged in interface ILcdModel
      Overrides:
      elementChanged in class ALcdModel
      Parameters:
      aElement - 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 aElements, int aEventMode)
      Description copied from class: ALcdModel
      Notifies this model that the elements in the specified vector have changed.

      This implementation calls TLcdModelChangedEventSupport#elementsChanged(java.util.Vector, int).

      Specified by:
      elementsChanged in interface ILcdModel
      Overrides:
      elementsChanged in class ALcdModel
      Parameters:
      aElements - 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()
      Description copied from class: ALcdModel
      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 calls #TLcdModelChangedEventSupport#fireCollectedModelChanges().

      Specified by:
      fireCollectedModelChanges in interface ILcdModel
      Overrides:
      fireCollectedModelChanges in class ALcdModel
      See Also: