com.luciad.symbology.milstd2525b.model

Defense SymbologyClass TLcdMS2525bEchelonNode

java.lang.Object

com.luciad.symbology.milstd2525b.model.TLcdMS2525bEchelonNode

public class TLcdMS2525bEchelonNode
extends Object

Tree structured representation of all echelon values supported by the given MIL-STD 252525 standard. Use getRoot(com.luciad.symbology.milstd2525b.model.ELcdMS2525Standard) to access the root, and getChildren() to list its children.

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

Since:

2013.1

See Also:

getRoot(com.luciad.symbology.milstd2525b.model.ELcdMS2525Standard)

Method Summary

Modifier and Type	Method and Description
void	applyOn(ILcdEditableMS2525bCoded aObject) Sets this echelon for the given object.
boolean	canApplyOn(ILcdMS2525bCoded aObject) Returns if this echelon can be set on the given object.
static TLcdMS2525bEchelonNode	get(ILcdMS2525bCoded aObject) Returns the echelon modifier currently set on the given object.
List<TLcdMS2525bEchelonNode>	getChildren() Returns a list of the node's children.
String	getCodeMask() Deprecated. use applyOn(com.luciad.symbology.milstd2525b.model.ILcdEditableMS2525bCoded) to apply the echelon value
static TLcdMS2525bEchelonNode	getDefault(ELcdMS2525Standard aStandard) Returns a default echelon modifier
String	getName() Returns the echelon modifier name.
ILcdIcon	getPreviewIcon() Returns a preview icon.
static TLcdMS2525bEchelonNode	getRoot(ELcdMS2525Standard aStandard) Returns a node with a hierarchic structure of all echelon modifiers of the given standard.
ELcdMS2525Standard	getStandard() Returns the standard.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getStandard

public ELcdMS2525Standard getStandard()

Returns the standard.

Returns:

the standard.

getChildren

public List<TLcdMS2525bEchelonNode> 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(ILcdMS2525bCoded 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(ILcdEditableMS2525bCoded aObject)

Sets this echelon for the given object.

Parameters:

aObject - an object

See Also:

canApplyOn(com.luciad.symbology.milstd2525b.model.ILcdMS2525bCoded)

getCodeMask

public String getCodeMask()

Deprecated. use applyOn(com.luciad.symbology.milstd2525b.model.ILcdEditableMS2525bCoded) to apply the echelon value

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 TLcdMS2525bEchelonNode getRoot(ELcdMS2525Standard 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 TLcdMS2525bEchelonNode getDefault(ELcdMS2525Standard aStandard)

Returns a default echelon modifier

Parameters:

aStandard - the symbology standard

Returns:

a default echelon modifier

get

public static TLcdMS2525bEchelonNode get(ILcdMS2525bCoded 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