Package com.luciad.symbology.military

Class MilitarySymbologyNode

java.lang.Object
com.luciad.symbology.military.MilitarySymbologyNode
All Implemented Interfaces:
AutoCloseable
public final class MilitarySymbologyNode extends Object implements AutoCloseable
Representation of a military symbol.

  • Method Details

    • finalize

      protected void finalize()
      Overrides:
      finalize in class Object

    • close

      public void close()
      Specified by:
      close in interface AutoCloseable

    • getName

      @NotNull public String getName()
      Returns the descriptive name for this symbol.
      Returns:
      the descriptive name for this symbol.

    • getCode

      @NotNull public String getCode()
      Returns the identifier uniquely defining the symbol, or null if the node does not represent a symbol.
      Returns:
      the identifier uniquely defining the symbol, or null if the node does not represent a symbol.

    • getSymbolType

      @Nullable public MilitarySymbologyNode.SymbolType getSymbolType()
      Returns the current type of symbol, can either be a shape or and icon or null if the node does not represent a symbol.
      Returns:
      the current type of symbol, can either be a shape or and icon or null if the node does not represent a symbol.

    • isFolderOnly

      public boolean isFolderOnly()
      Returns whether this node is a folder-only node, i.e.

      if it doesn't represent a symbol.

      Returns:
      whether this node is a folder-only node, i.e. if it doesn't represent a symbol.

    • getParent

      @Nullable public MilitarySymbologyNode getParent()
      Returns the parent of this node, or a null value if this node is a root node.
      Returns:
      the parent of this node, or a null value if this node is a root node.

    • getChildren

      @NotNull public List<@NotNull MilitarySymbologyNode> getChildren()
      Returns the child nodes of this node.

      Empty if this node is a leaf node.

      Returns:
      the child nodes of this node.

    • getMaximumPointCount

      @Nullable public Long getMaximumPointCount()
      Returns the maximum number of points that a shape representing this node should have.

      If there is no restriction in the number of points or if the node is represented by an icon or does not represent a symbol at all, this returns null.

      Returns:
      the maximum number of points that a shape representing this node should have.

    • getMinimumPointCount

      public long getMinimumPointCount()
      Returns the minimum number of points that a shape representing this node should have.
      Returns:
      the minimum number of points that a shape representing this node should have.

    • createTemplate

      @Nullable public Geometry createTemplate(@NotNull CoordinateReference crs, double x, double y, double size)
      Creates a suitable geometry for this symbology node, at the given location and of the provided size.

      This can be used as a convenience for programmatically creating geometries. The returned geometry can be a point, polyline or polygon.

      Parameters:
      crs - the coordinate reference of the geometry.
      x - the x-coordinate where the template will be created.
      y - the y-coordinate where the template will be created.
      size - the approximate size of the final template, in the units of the given coordinate reference system.
      Returns:
      a geometry that can represent the symbol of this node, or null if this node does not represent a symbol.