com.highqsoft.moma.rules.mdf

Class MdfHelper

java.lang.Object

com.highqsoft.moma.rules.mdf.MdfHelper

public class MdfHelper
extends java.lang.Object

The Mdf4Helper class provides some utility methods for the other rules in the package.

Author:

markus

Constructor Summary

Constructors

Constructor and Description
MdfHelper()

Method Summary

Methods

Modifier and Type	Method and Description
boolean[]	ccValToBooleanArray(java.util.List<java.lang.String> list) Parse the keys of a lookup table as boolean values
byte[]	ccValToByteArray(java.util.List<java.lang.String> list) Parse the keys of a lookup table as byte values
int[]	ccValToLongArray(java.util.List<java.lang.String> ccVal) Parse the keys of a lookup table as long values
T_LONGLONG[]	ccValToLongLongArray(java.util.List<java.lang.String> ccVal) Parse the keys of a lookup table as T_LONGLONG values
short[]	ccValToShortArray(java.util.List<java.lang.String> ccVal) Parse the keys of a lookup table as short values
int	checkAndConvertOdsTypespecToSignedDataType(int odsTypespec, int bitCount) This method checks if the passed ods typespec is unsigned and the passed bit count is less enough, so the typespec is changed to signed typespec.
NameValueUnit	createInvalidAttribute(java.lang.String name, DataType dt) Create a NameValueUnit for an invalid attribute
int	getCorrespondingLeoValueType(int typeSpecEnumValue) Returns the corresponding LEO typespec enum value for the passed BEO value.
static MdfHelper	getInstance()
long	getMaxChannelId(com.highqsoft.mdf410.xsd.CgBlock cgBlock) Find the highest used channel id within a channel group
int	getRecIdSizeInBytes(com.highqsoft.mdf410.xsd.RECORDIDTYPE dgRecIdSize) Converts the recordIdType to the number of bytes used by the record id
int	getTypeSpecEnumLengthInBytes(int typeSpecEnumValue, long bitCount) This methods return the length in bytes of the given TypeSpecEnumValue.
boolean	isBeoValueType(int typeSpecEnumValue) Return true, if the passed TypeSpec Enumvalue if a Big Endian Organized data type.
boolean	isBitIsSet(byte value, int bit) Check if a specific Bit in a byte value is set
boolean	isBitIsSet(int value, int bit) Check if a specific Bit in an integer value is set
boolean	isBitIsSet(long value, int bit) Check if a specific Bit in an long value is set
boolean	isUnsignedValueType(int typeSpecEnumValue) Return true, if the passed TypeSpec Enumvalue if a Big Endian Organized data type.
boolean	isVlsdValueType(int typeSpecEnumValue) Return true, if the passed TypeSpec Enumvalue has variable length data data.
DataType	mapMdf4DatatypeToOdsDatatype(com.highqsoft.mdf410.xsd.CnBlock cnBlock) Convert the mdf datatypes to ODS datatypes The MDF types are made of a datatype and a number of bits.
int	mapMdf4DatatypeToOdsTypespec(com.highqsoft.mdf410.xsd.CnBlock cnBlock) Convert the mdf datatypes to an ODS typespec used in external components The MDF types are made of a datatype and a number of bits.
java.lang.String	parseMdf4CgMdComment(java.lang.String comment) The comment used for the LC desctiption contains a structure, so we have to parse the interesting part from the original comment.
java.lang.String	parseMdf4CnMdComment(java.lang.String comment) The comment used for the Meq desctiption contains a structure, so we have to parse the interesting part from the original comment.
java.lang.String	parseUnit(java.lang.String cnUnit) Parse the unit from the CDATA section
byte	setBit(byte value, int bitNumber, int valueToSet) Sets a bit to the passed value in the given byte
byte	setBitRange(byte value, int bitNumberStart, int bitNumberEnd, int valueToSet) Sets a range of bits in the given byte to the passed value
byte[]	uncompressZipBlock(byte[] compressedData, long zipParameter)

Methods inherited from class java.lang.Object

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

Constructor Detail

MdfHelper

public MdfHelper()

Method Detail

getInstance

public static MdfHelper getInstance()

createInvalidAttribute

public NameValueUnit createInvalidAttribute(java.lang.String name,
                                   DataType dt)

Create a NameValueUnit for an invalid attribute

Parameters:

name - The name of the attribute

dt - The data type of the attribute

Returns:

The NameValueUnit for the attribute

getRecIdSizeInBytes

public int getRecIdSizeInBytes(com.highqsoft.mdf410.xsd.RECORDIDTYPE dgRecIdSize)

Converts the recordIdType to the number of bytes used by the record id

Parameters:

dgRecIdSize - The Record Id Type

Returns:

The number of bytes used by the record id

isBitIsSet

public boolean isBitIsSet(byte value,
                 int bit)

Check if a specific Bit in a byte value is set

Parameters:

value - The integer value to check

bit - The bit number (rightmost bit is 0)

Returns:

true if the bit is set

isBitIsSet

public boolean isBitIsSet(int value,
                 int bit)

Check if a specific Bit in an integer value is set

Parameters:

value - The integer value to check

bit - The bit number (rightmost bit is 0)

Returns:

true if the bit is set

isBitIsSet

public boolean isBitIsSet(long value,
                 int bit)

Check if a specific Bit in an long value is set

Parameters:

value - The long value to check

bit - The bit number (rightmost bit is 0)

Returns:

true if the bit is set

setBit

public byte setBit(byte value,
          int bitNumber,
          int valueToSet)

Sets a bit to the passed value in the given byte

Parameters:

value - byte in which the bit should be set

bitNumber - number of the bit to set

valueToSet - 0 or 1

Returns:

the manipulated byte

setBitRange

public byte setBitRange(byte value,
               int bitNumberStart,
               int bitNumberEnd,
               int valueToSet)

Sets a range of bits in the given byte to the passed value

Parameters:

value - byte in which the bit should be set

bitNumberStart - the first postion to change

bitNumberEnd - the last postion to change

Returns:

the manipulated byte

getMaxChannelId

public long getMaxChannelId(com.highqsoft.mdf410.xsd.CgBlock cgBlock)

Find the highest used channel id within a channel group

Parameters:

cgBlock - The CgBlock

Returns:

the highest channel id within this channel group

parseUnit

public java.lang.String parseUnit(java.lang.String cnUnit)

Parse the unit from the CDATA section

Parameters:

cnUnit - The CDATA section containing the unit in square braces

Returns:

The plain unit name

ccValToBooleanArray

public boolean[] ccValToBooleanArray(java.util.List<java.lang.String> list)
                              throws java.lang.NumberFormatException

Parse the keys of a lookup table as boolean values

Parameters:

list - String list containing the keys

Returns:

a boolean array containing the parsed strings

Throws:

java.lang.NumberFormatException

ccValToByteArray

public byte[] ccValToByteArray(java.util.List<java.lang.String> list)
                        throws java.lang.NumberFormatException

Parse the keys of a lookup table as byte values

Parameters:

list - String list containing the keys

Returns:

a byte array containing the parsed strings

Throws:

java.lang.NumberFormatException

ccValToShortArray

public short[] ccValToShortArray(java.util.List<java.lang.String> ccVal)
                          throws java.lang.NumberFormatException

Parse the keys of a lookup table as short values

Parameters:

list - String list containing the keys

Returns:

a short array containing the parsed strings

Throws:

java.lang.NumberFormatException

ccValToLongArray

public int[] ccValToLongArray(java.util.List<java.lang.String> ccVal)
                       throws java.lang.NumberFormatException

Parse the keys of a lookup table as long values

Parameters:

list - String list containing the keys

Returns:

a long array containing the parsed strings

Throws:

java.lang.NumberFormatException

ccValToLongLongArray

public T_LONGLONG[] ccValToLongLongArray(java.util.List<java.lang.String> ccVal)
                                  throws java.lang.NumberFormatException

Parse the keys of a lookup table as T_LONGLONG values

Parameters:

list - String list containing the keys

Returns:

a T_LONGLONG array containing the parsed strings

Throws:

java.lang.NumberFormatException

parseMdf4CnMdComment

public java.lang.String parseMdf4CnMdComment(java.lang.String comment)

The comment used for the Meq desctiption contains a structure, so we have to parse the interesting part from the original comment.

Parameters:

comment - The comment as it comes from the Mdf file

Returns:

The parsed comment

parseMdf4CgMdComment

public java.lang.String parseMdf4CgMdComment(java.lang.String comment)

The comment used for the LC desctiption contains a structure, so we have to parse the interesting part from the original comment.

Parameters:

comment - The comment as it comes from the Mdf file

Returns:

The parsed comment

mapMdf4DatatypeToOdsTypespec

public int mapMdf4DatatypeToOdsTypespec(com.highqsoft.mdf410.xsd.CnBlock cnBlock)
                                 throws InvalidArgumentException

Convert the mdf datatypes to an ODS typespec used in external components The MDF types are made of a datatype and a number of bits. Not all combinations are currently supported. In case of an unsupported data type a warning is written to the messanger file

Parameters:

cnBlock - The channelBlock. Contains mdf datatype and number of bits used

Returns:

The ODS typespec enum value. -1 if the mdf datatype cannot be converted.

Throws:

InvalidArgumentException

checkAndConvertOdsTypespecToSignedDataType

public int checkAndConvertOdsTypespecToSignedDataType(int odsTypespec,
                                             int bitCount)

This method checks if the passed ods typespec is unsigned and the passed bit count is less enough, so the typespec is changed to signed typespec. Otherwiese the passed typespec is returned.

Parameters:

odsTypespec, - the current ods typespec

bitCount, - the number of bits which use the current data type

mapMdf4DatatypeToOdsDatatype

public DataType mapMdf4DatatypeToOdsDatatype(com.highqsoft.mdf410.xsd.CnBlock cnBlock)
                                      throws InvalidArgumentException

Convert the mdf datatypes to ODS datatypes The MDF types are made of a datatype and a number of bits. Not all combinations are currently supported. In case of an unsupported data type a warning is written to the messanger file

Parameters:

cnBlock - The channelBlock. Contains mdf datatype and number of bits used

Returns:

The ODS datatype. Null if the mdf datatype cannot be converted.

Throws:

InvalidArgumentException

getTypeSpecEnumLengthInBytes

public int getTypeSpecEnumLengthInBytes(int typeSpecEnumValue,
                               long bitCount)

This methods return the length in bytes of the given TypeSpecEnumValue. When type is not known, the method returns -1.

Parameters:

typeSpecEnumValue -

isBeoValueType

public boolean isBeoValueType(int typeSpecEnumValue)

Return true, if the passed TypeSpec Enumvalue if a Big Endian Organized data type.

isUnsignedValueType

public boolean isUnsignedValueType(int typeSpecEnumValue)

Return true, if the passed TypeSpec Enumvalue if a Big Endian Organized data type.

getCorrespondingLeoValueType

public int getCorrespondingLeoValueType(int typeSpecEnumValue)

Returns the corresponding LEO typespec enum value for the passed BEO value.

isVlsdValueType

public boolean isVlsdValueType(int typeSpecEnumValue)

Return true, if the passed TypeSpec Enumvalue has variable length data data. This data type has a separate data block.

uncompressZipBlock

public byte[] uncompressZipBlock(byte[] compressedData,
                        long zipParameter)