Class TLcdAPP6AEchelonNode

java.lang.Object
com.luciad.symbology.app6a.model.TLcdAPP6AEchelonNode

public final class TLcdAPP6AEchelonNode extends Object
Tree structured representation of all echelon (e.g. size/mobility) values supported by the given APP-6 standard. Use getRoot(com.luciad.symbology.app6a.model.ELcdAPP6Standard) to access the root, and getChildren() to list its children.

An echelon value can be retrieved from and applied to any ILcdAPP6ACoded instance.

Note that the term 'echelon' was taken from the MIL-STD 252525 standard. The APP-6 standard instead refers to this concept using the term 'size/mobility'.

Since:
2013.1
See Also:
  • Method Details

    • getStandard

      public ELcdAPP6Standard getStandard()
      Returns the standard.
      Returns:
      the standard.
    • getChildren

      public List<TLcdAPP6AEchelonNode> getChildren()
      Returns a list of the node's children.
      Returns:
      a list of the node's children.
    • getName

      public String getName()
      Returns the echelon modifier name.
      Returns:
      the echelon modifier name.
    • getPreviewIcon

      public ILcdIcon getPreviewIcon()
      Returns a preview icon.
      Returns:
      a preview icon.
    • canApplyOn

      public boolean canApplyOn(ILcdAPP6ACoded aObject)
      Returns if this echelon can be set on the given object.
      Parameters:
      aObject - an object.
      Returns:
      if this echelon can be set on the given object.
    • applyOn

      public void applyOn(ILcdEditableAPP6ACoded aObject)
      Sets this echelon for the given object.
      Parameters:
      aObject - an object
      See Also:
    • getCodeMask

      @Deprecated public String getCodeMask()
      Deprecated.
      Since code mask are no longer used in more recent symbologies (APP6-C, APP6-D, ..). Use the getName() to identify the echelon and applyOn(ILcdEditableAPP6ACoded) to set the echelon of a ILcdEditableAPP6ACoded.
      Returns a code mask that corresponds to this echelon.
      Returns:
      a 15 character code which contains characters different from the mask character at the relevant positions.
    • getRoot

      public static TLcdAPP6AEchelonNode getRoot(ELcdAPP6Standard aStandard)
      Returns a node with a hierarchic structure of all echelon modifiers of the given standard.
      Parameters:
      aStandard - the symbology standard
      Returns:
      a node containing with echelon modifiers for the domains of the given standard
    • getDefault

      public static TLcdAPP6AEchelonNode getDefault(ELcdAPP6Standard aStandard)
      Returns a default echelon modifier
      Parameters:
      aStandard - the symbology standard
      Returns:
      a default echelon modifier
    • get

      public static TLcdAPP6AEchelonNode get(ILcdAPP6ACoded aObject)
      Returns the echelon modifier currently set on the given object.
      Parameters:
      aObject - an object.
      Returns:
      the echelon modifier currently set on the given object.
    • toString

      public String toString()
      Overrides:
      toString in class Object