eu.baltrad.beast.rules.namer.QuantityHexNameCreator Class Reference

Creates a 64-bit hex string representation of the quantities according to a predefined list of quantities. More...

Inheritance diagram for eu.baltrad.beast.rules.namer.QuantityHexNameCreator:

Public Member Functions
	QuantityHexNameCreator ()
	Default constructor.
	QuantityHexNameCreator (Map< String, Integer > map)
	Constructor.
	QuantityHexNameCreator (Map< String, Integer > map, boolean shiftLeft)
	Constructor.
	QuantityHexNameCreator (File file)
	Constructor.
boolean	supports (String tag)
String	createName (String tag, Metadata metadata)

Protected Member Functions
BigInteger	createMaskFromIntegers (List< Integer > integers)
	Creates the bit pattern.
String	getAttributeValue (Metadata metadata, String attrPath)
	Returns the value for the specified path in the metadata.
void	parseFile (File file)
boolean	isLeftShifting (Document doc)
	Verifies if the shifting should be performed left to right or right to left.
Map< String, Integer >	parseMapping (Document doc)
	Parses the quantities xml file.

Detailed Description

Creates a 64-bit hex string representation of the quantities according to a predefined list of quantities.

Author

Anders Henja

Constructor & Destructor Documentation

QuantityHexNameCreator() [1/4]

eu.baltrad.beast.rules.namer.QuantityHexNameCreator.QuantityHexNameCreator ( )

inline

Default constructor.

QuantityHexNameCreator() [2/4]

eu.baltrad.beast.rules.namer.QuantityHexNameCreator.QuantityHexNameCreator ( Map< String, Integer > map )

inline

Constructor.

Parameters

map	the mapping between quantity and bit position

QuantityHexNameCreator() [3/4]

eu.baltrad.beast.rules.namer.QuantityHexNameCreator.QuantityHexNameCreator ( Map< String, Integer > map, boolean shiftLeft )

inline

Constructor.

Parameters

map	the mapping between quantity and bit position
shiftLeft	if the bit pattern should be masked from left or right

QuantityHexNameCreator() [4/4]

eu.baltrad.beast.rules.namer.QuantityHexNameCreator.QuantityHexNameCreator ( File file )

inline

Constructor.

Parameters

file	the mapping as a xml file

Member Function Documentation

createMaskFromIntegers()

BigInteger eu.baltrad.beast.rules.namer.QuantityHexNameCreator.createMaskFromIntegers ( List< Integer > integers )

inlineprotected

Creates the bit pattern.

Parameters

integers

a list of integer positions

Returns

the created long value

createName()

String eu.baltrad.beast.rules.namer.QuantityHexNameCreator.createName ( String tag, Metadata metadata )

inline

See also

eu.baltrad.beast.rules.namer.MetadataNameCreator.createName(eu.baltrad.bdb.oh5.Metadata)

Implements eu.baltrad.beast.rules.namer.MetadataNameCreator.

getAttributeValue()

String eu.baltrad.beast.rules.namer.QuantityHexNameCreator.getAttributeValue ( Metadata metadata, String attrPath )

inlineprotected

Returns the value for the specified path in the metadata.

Parameters

metadata	the metadata
attrPath	the node path

Returns

the string value if found, otherwise null

isLeftShifting()

boolean eu.baltrad.beast.rules.namer.QuantityHexNameCreator.isLeftShifting ( Document doc )

inlineprotected

Verifies if the shifting should be performed left to right or right to left.

Parameters

doc	the document

Returns

if shifting should be performed to left or right

parseMapping()

Map< String, Integer > eu.baltrad.beast.rules.namer.QuantityHexNameCreator.parseMapping ( Document doc )

inlineprotected

Parses the quantities xml file.

Parameters

file

the file

Returns

a map

supports()

boolean eu.baltrad.beast.rules.namer.QuantityHexNameCreator.supports ( String tag )

inline

See also

MetadataNameCreator.supports(String)

Implements eu.baltrad.beast.rules.namer.MetadataNameCreator.

---

The documentation for this class was generated from the following file:

• src/eu/baltrad/beast/rules/namer/QuantityHexNameCreator.java