Package com.luciad.symbology.milstd2525b.model

Class TLcdMS2525bCode2HierarchyMap

java.lang.Object

com.luciad.symbology.milstd2525b.model.TLcdMS2525bCode2HierarchyMap

public class TLcdMS2525bCode2HierarchyMap
extends Object

Support class to convert MIL-STD 2525 15 character codes to hierarchy signatures and back.

Field Summary

Fields

Modifier and Type	Field	Description
static final char	MASKCHARACTER	Mask character to denote that the character at this position should not be taken into account.

Method Summary

Modifier and Type	Method	Description
String	getHierarchySignature(String aMS2525bCode)	Returns the hierarchy signature corresponding to the given MIL-STD 2525 code.
static TLcdMS2525bCode2HierarchyMap	getInstance()	Returns the singleton instance of the code to hierarchy signature map, using the default standard.
static TLcdMS2525bCode2HierarchyMap	getInstance(ELcdMS2525Standard aStandard)	Returns the singleton instance of the code to hierarchy signature map, using the given standard.
String	getMS2525bCodeMask(String aHierarchySignature)	Returns a MIL-STD 2525 code mask that corresponds to the given hierarchy signature.
static boolean	isTraceOn()	Deprecated. This method has been deprecated.
static void	setClassTraceOn(boolean aClassTraceOn)	Deprecated. This method has been deprecated.

Methods inherited from class java.lang.Object

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

Field Details

MASKCHARACTER

public static final char MASKCHARACTER

Mask character to denote that the character at this position should not be taken into account.

See Also:

• getMS2525bCodeMask(java.lang.String)
• Constant Field Values

Method Details

isTraceOn

@Deprecated
public static boolean isTraceOn()

Deprecated.

This method has been deprecated. It is recommended to use the standard Java logging framework directly.

Returns true if tracing is enabled for this class.

Returns:

true if tracing is enabled for this class, false otherwise.

setClassTraceOn

@Deprecated
public static void setClassTraceOn(boolean aClassTraceOn)

Deprecated.

This method has been deprecated. It is recommended to use the standard Java logging framework directly.

Enables tracing for all instances of this class. If the argument is true then all log messages are recorded, otherwise only the informative, warning and error messages are recorded.

Parameters:

aClassTraceOn - if true then all log messages are recorded, otherwise only the informative, warning and error messages are recorded.

getInstance

public static TLcdMS2525bCode2HierarchyMap getInstance()

Returns the singleton instance of the code to hierarchy signature map, using the default standard.

Returns:

the singleton instance of the MIL-STD 2525b code to hierarchy signature map.

getInstance

public static TLcdMS2525bCode2HierarchyMap getInstance(ELcdMS2525Standard aStandard)

Returns the singleton instance of the code to hierarchy signature map, using the given standard.

Returns:

the singleton instance of the MIL-STD 2525b code to hierarchy signature map.

Since:

2013.1

getHierarchySignature

public String getHierarchySignature(String aMS2525bCode)

Returns the hierarchy signature corresponding to the given MIL-STD 2525 code.

Parameters:

aMS2525bCode - a MIL-STD 2525 code.

Returns:

the hierarchy signature corresponding to the given MIL-STD 2525b code.

Throws:

IllegalArgumentException - when no hierarchy can be found for the given code.

getMS2525bCodeMask

public String getMS2525bCodeMask(String aHierarchySignature)

Returns a MIL-STD 2525 code mask that corresponds to the given hierarchy signature.

Parameters:

aHierarchySignature - a signature denoting a hierarchy.

Returns:

a 15 character code which contains characters different from the mask character at the relevant positions.

Throws:

IllegalArgumentException - when no code mask can be found for the given signature.