OdsxHelper

java.lang.Object
- com.highqsoft.odsx.OdsxHelper

public class OdsxHelper
extends java.lang.Object

The OdsxHelper is an set of static methods for standard tasks to be done for ODS.

Property Keyword	Datatype	Default	Description
OdsxHelper.FlagsAsBits	boolean	true	If false the method flagsToString return a human readable text for flag value. Else the bit presentation is returned.

Since:: $Date: 2017/04/28 08:47:45 $
Version:: $Revision: 1.47 $
Author:: HighQSoft GmbH
See Also:

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DE_DATE_FORMAT` The DE language date format.
`static boolean`	`deLang`
`protected static java.lang.String`	`FLAG_FILLER`
`static boolean`	`FLAGS_AS_BITS`
`static java.lang.String`	`ODS_DATE_FORMAT` The ASAM ODS date format.
`static java.lang.String`	`ODS_VERSION` The default ODS version string.
`static java.lang.String`	`OTHER_DATE_FORMAT` The other language date format.
`static java.lang.String`	`version`

Method Summary

Methods
Modifier and Type	Method and Description
`static java.lang.String`	`aoExceptionToString(AoException aoException)` Get the string of the AoException.
`static java.lang.String`	`applAttrToString(ApplAttr aa)` This method returns the ApplAttr as a string.
`static java.lang.String`	`applElemToString(ApplElem ae)` This method returns the ApplElem as a string.
`static java.lang.String`	`applicationStructureValueToString(ApplicationStructureValue asStr)` This method returns the ApplicationStructureValue as a string.
`static java.lang.String`	`applRelToString(ApplRel ar)` This method returns the ApplRel as a string.
`static Blob`	`clone(Blob val)` Clone a blob value.
`static boolean[]`	`clone(boolean[] val)` Clone a boolean sequence value.
`static byte[]`	`clone(byte[] val)` Clone a byte sequence value.
`static byte[][]`	`clone(byte[][] val)` Clone a byte stream sequence value.
`static double[]`	`clone(double[] val)` Clone a double sequence value.
`static float[]`	`clone(float[] val)` Clone a float sequence value.
`static int[]`	`clone(int[] val)` Clone a long sequence value.
`static NameValueUnit`	`clone(NameValueUnit nvu)` Clone a name value unit.
`static short[]`	`clone(short[] val)` Clone a short sequence value.
`static java.lang.String[]`	`clone(java.lang.String[] val)` Clone a string sequence value.
`static T_COMPLEX`	`clone(T_COMPLEX val)` Clone a T_COMPLEX value.
`static T_COMPLEX[]`	`clone(T_COMPLEX[] val)` Clone a T_COMPLEX sequence value.
`static T_DCOMPLEX`	`clone(T_DCOMPLEX val)` Clone a T_DCOMPLEX value.
`static T_DCOMPLEX[]`	`clone(T_DCOMPLEX[] val)` Clone a T_DCOMPLEX sequence value.
`static T_ExternalReference`	`clone(T_ExternalReference val)` Clone a T_ExternalReference value.
`static T_ExternalReference[]`	`clone(T_ExternalReference[] val)` Clone a T_ExternalReference sequence value.
`static T_LONGLONG`	`clone(T_LONGLONG val)` Clone a T_LONGLONG value.
`static T_LONGLONG[]`	`clone(T_LONGLONG[] val)` Clone a T_LONGLONG sequence value.
`static InstanceElement`	`copyInstance(java.lang.String name, java.lang.String version, java.lang.String description, InstanceElement source, InstanceElement parent)` Copy an instance inside the same session.
`static NameValueUnit`	`createNameValueUnit(java.lang.String name, DataType datatype, java.lang.String unit)` Create a name value unit.
`static NameValueUnit`	`createNameValueUnit(java.lang.String name, java.lang.String unit, DataType dt, java.lang.String value)` This method creates a name value unit parsing the given string according to the given datatype.
`static java.lang.String`	`datatypeToString(DataType dt)` This method returns the value of a DataType as a string.
`static DataType`	`DS2DT(DataType dt)` Return an datatype of the given sequence datatype.
`static DataType`	`DT2DS(DataType dt)` Return an sequence datatype of the given datatype.
`static java.lang.String`	`escapePattern(java.lang.String pattern)` Return the pattern with the special pattern characters escaped.
`static java.lang.String`	`flagsToString(short flag)` Get the flag string.
`static InstanceElement[]`	`getChildren(InstanceElement ieObj)` Get the children of an instance element.
`static short[]`	`getFlags(InstanceElement column)` Get the flags of a column.
`static float`	`getHighestVersion(T_LONGLONG parIId, T_LONGLONG parAId, ApplicationElement aeObj, java.lang.String instanceName)` Get the highest version of instance element.
`static java.lang.String`	`getHighestVersionString(T_LONGLONG parIId, T_LONGLONG parAId, ApplicationElement aeObj, java.lang.String instanceName)` Get the highest string version of instance element.
`static InstanceElement[]`	`getInstancesById(ApplicationStructure asObj, ElemId[] ei)` Get the instances by id.
`static NameValueUnit`	`getNameValueUnit(java.lang.String name, boolean value)` This static method creates a nameValueUnit with the given name containing the given value
`static NameValueUnit`	`getNameValueUnit(java.lang.String name, byte value)` This static method creates a nameValueUnit with the given name containing the given value
`static NameValueUnit`	`getNameValueUnit(java.lang.String name, double value)` This static method creates a nameValueUnit with the given name containing the given value
`static NameValueUnit`	`getNameValueUnit(java.lang.String name, float value)` This static method creates a nameValueUnit with the given name containing the given value
`static NameValueUnit`	`getNameValueUnit(java.lang.String name, int value)` This static method creates a nameValueUnit with the given name containing the given value
`static NameValueUnit`	`getNameValueUnit(java.lang.String name, short value)` This static method creates a nameValueUnit with the given name containing the given value
`static NameValueUnit`	`getNameValueUnit(java.lang.String name, java.lang.String value)` This static method creates a nameValueUnit with the given name containing the given value
`static NameValueUnit`	`getNameValueUnitDate(java.lang.String name, java.lang.String date)` This static method creates a nameValueUnit with the given name containing the given date
`static java.lang.String`	`getOdsDate(java.util.Date date)` Get the ODS version of the given date.
`static java.lang.String`	`getODSVersion(AoSession session)` Get the ods version of the given session.
`static java.lang.String`	`getODSVersion(OdsxSessionInterface session)` Get the ods version of the given session.
`static ApplicationElement`	`getParent(ApplicationElement aeObj)` Get the parent of an instance element.
`static InstanceElement`	`getParent(InstanceElement ieObj)` Get the parent of an instance element.
`static double[]`	`getRating(InstanceElement column)` Get the rating of an independent column.
`static ApplicationElement`	`getSuperTypeElementByBaseType(ApplicationStructure as, java.lang.String baseType)` Get the super type element of the ASAM ODS base type.
`static int`	`getTypeSize(DataType datatype)` Get the type size of a ODS value.
`static int`	`getTypeSize(int datatype)` Get the type size of a ODS value.
`static int`	`getTypeSize(TS_Value value)` Get the type size of a ODS value.
`static java.lang.String`	`getVersion()`
`static java.lang.String`	`getVersion(InstanceElement instance)` Return the version string of an instance element.
`static boolean`	`hasSelfReference(ApplicationElement aeObj)` Return a boolean whether the elements ahs a self reference.
`static long`	`isImplicit(InstanceElement column)` return a boolean whether the column is independent.
`static boolean`	`isIndependent(InstanceElement column)` Return a boolean whether the given local column is defined as independent.
`static T_LONGLONG`	`longToT_longlong(long id)` Get T_LONGLONG presentation of a long.
`static void`	`main(java.lang.String[] args)` The main test procedure.
`static java.lang.String`	`nameValueSeqUnitIdToString(NameValueSeqUnitId nvu)` This method returns the value of a NameValueSeqUnitId structure as a string.
`static java.lang.String`	`nameValueSeqUnitToString(NameValueSeqUnit nvu)` This method returns the value of a NameValueSeqUnit structure as a string.
`static java.lang.String`	`nameValueToString(NameValue nvu)` This method returns the value of a NameValue structure as a string.
`static java.lang.String`	`nameValueUnitToString(NameValueUnit nvu)` This method returns the value of a NameValueUnit structure as a string.
`static boolean`	`parseBoolean(java.lang.String value)` Parse a boolean string value.
`static T_COMPLEX`	`parseComplex(java.lang.String value)` Parse a T_COMPLEX string value.
`static T_DCOMPLEX`	`parseDComplex(java.lang.String value)` Parse a T_DCOMPLEX string value.
`static T_LONGLONG`	`parseLongLong(java.lang.String value)` Parse a T_LONGLONG string value.
`static NameValueUnit`	`parseNameValueUnit(NameValueUnit nvu, java.lang.String value)` This method returns the value of a TS_Union structure as a string.
`static TS_Union`	`parseTS_Union(DataType dt, java.lang.String value)` This method returns the value of a TS_Union structure as a string.
`static TS_Union`	`parseTS_Union(DataType dt, java.lang.String[] value)` This method returns the value of a TS_Union structure as a string array.
`static TS_UnionSeq`	`parseTS_UnionSeq(DataType dt, java.lang.String[] value)`
`static java.lang.String`	`relationRangeToString(RelationRange relRange)` This method returns the RelationType as a string.
`static java.lang.String`	`relationshipToString(Relationship relship)` This method returns the relationship as a string.
`static java.lang.String`	`relationTypeToString(RelationType relType)` This method returns the RelationType as a string.
`static java.lang.String`	`seqToString(Blob val)` This method returns a string presentation of a blob value.
`static java.lang.String`	`seqToString(Blob blob, int maxCount, boolean multiLine, int lineCount)` This method returns a string presentation of a blob value.
`static java.lang.String`	`seqToString(boolean[] val)` This method returns a string presentation of a boolean sequence value.
`static java.lang.String`	`seqToString(boolean[] val, int maxCount, boolean multiLine, int lineCount)` This method returns a string presentation of a boolean sequence value.
`static java.lang.String`	`seqToString(byte[] val)` This method returns a string presentation of a byte sequence value.
`static java.lang.String`	`seqToString(byte[] val, int maxCount, boolean multiLine, int lineCount)` This method returns a string presentation of a byte sequence value.
`static java.lang.String`	`seqToString(byte[] val, int maxCount, boolean multiLine, int lineCount, java.lang.String terminator)` This method returns a string presentation of a byte sequence value.
`static java.lang.String`	`seqToString(double[] val)` This method returns a string presentation of a double sequence value.
`static java.lang.String`	`seqToString(double[] val, int maxCount, boolean multiLine, int lineCount)` This method returns a string presentation of a double sequence value.
`static java.lang.String`	`seqToString(float[] val)` This method returns a string presentation of a float sequence value.
`static java.lang.String`	`seqToString(float[] val, int maxCount, boolean multiLine, int lineCount)` This method returns a string presentation of a float sequence value.
`static java.lang.String`	`seqToString(int[] val)` This method returns a string presentation of a int sequence value.
`static java.lang.String`	`seqToString(int[] val, int maxCount, boolean multiLine, int lineCount)` This method returns a string presentation of a int sequence value.
`static java.lang.String`	`seqToString(java.lang.Object[] val)` This method returns a string presentation of a sequence value.
`static java.lang.String`	`seqToString(java.lang.Object[] val, int maxCount, boolean multiLine, int lineCount)` This method returns a string presentation of a sequence value.
`static java.lang.String`	`seqToString(short[] val)` This method returns a string presentation of a short sequence value.
`static java.lang.String`	`seqToString(short[] val, int maxCount, boolean multiLine, int lineCount)` This method returns a string presentation of a short sequence value.
`static java.lang.String`	`seqToString(java.lang.String[] val)` This method returns a string presentation of a string sequence value.
`static java.lang.String`	`seqToString(java.lang.String[] val, int maxCount, boolean multiLine, int lineCount)` This method returns a string presentation of a string sequence value.
`static java.lang.String`	`seqToString(T_ExternalReference[] val)` This method returns a string presentation of a sequence value.
`static java.lang.String`	`seqToString(T_ExternalReference[] val, int maxCount, boolean multiLine, int lineCount)` This method returns a string presentation of a sequence value.
`static void`	`setAttributes(InstanceElement ieObj, java.util.Map attrs)` Set the attributes of an instance element according to the given map.
`static java.lang.String`	`severityFlagToString(SeverityFlag sevFlag)` Get the string of the SeverityFlag.
`protected static InstanceElement[]`	`sortInstancesByElemIds(InstanceElement[] ieArr, ElemId[] eiArr)` Sort the given instances by the given ElemIds.
`static java.lang.String`	`t_complexToString(T_COMPLEX complex)` Get string presentation of a T_COMPLEX.
`static java.lang.String`	`t_dcomplexToString(T_DCOMPLEX complex)` Get string presentation of a T_DCOMPLEX.
`static long`	`t_longlongToLong(T_LONGLONG id)` Get long presentation of a T_LONGLONG.
`static java.lang.String`	`t_longlongToString(T_LONGLONG id)` Get string presentation of a T_LONGLONG.
`static java.lang.String`	`ts_unionSeqToString(TS_UnionSeq ts)` This method returns the value of a TS_UnionSeq structure as a string.
`static java.lang.String`	`ts_unionSeqToString(TS_UnionSeq ts, int maxCount)` This method returns the value of a TS_UnionSeq structure as a string.
`static java.lang.String`	`ts_unionSeqToString(TS_UnionSeq ts, int maxCount, boolean multiLine, int lineCount)` This method returns the value of a TS_UnionSeq structure as a string.
`static java.lang.String`	`ts_unionToString(TS_Union ts)` This method returns the value of a TS_Union structure as a string.
`static java.lang.String`	`ts_unionToString(TS_Union ts, int maxCount)` This method returns the value of a TS_Union structure as a string.
`static java.lang.String`	`ts_unionToString(TS_Union ts, int maxCount, boolean multiLine, int lineCount)` This method returns the value of a TS_Union structure as a string.
`static java.lang.String`	`ts_valueSeqToString(TS_ValueSeq ts)` This method returns the value of a TS_ValueSeq structure as a string.
`static java.lang.String`	`ts_valueToString(TS_Value ts)` This method returns the value of a TS_Value structure as a string.
`static java.lang.String`	`valToString(byte[] val)` This method returns a string presentation of a BYTESTR value.
`static java.lang.String`	`valToString(java.lang.Object val)` This method returns a string presentation of a value.
`static java.lang.String`	`valToString(java.lang.String date)` This method returns a string presentation of a date value.
`static java.lang.String`	`valToString(T_COMPLEX val)` This method returns a string presentation of a T_COMPLEX value.
`static java.lang.String`	`valToString(T_DCOMPLEX val)` This method returns a string presentation of a T_DCOMPLEX value.
`static java.lang.String`	`valToString(T_ExternalReference val)` This method returns a string presentation of a T_ExternalReference value.
`static java.lang.String`	`valToString(T_LONGLONG val)` This method returns a string presentation of a T_LONGLONG value.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - version
```
public static final java.lang.String version
```
    See Also:
    Constant Field Values
  - ODS_VERSION
```
public static final java.lang.String ODS_VERSION
```
    The default ODS version string.
    
    See Also:
    Constant Field Values
  - ODS_DATE_FORMAT
```
public static final java.lang.String ODS_DATE_FORMAT
```
    The ASAM ODS date format.
    
    See Also:
    Constant Field Values
  - DE_DATE_FORMAT
```
public static final java.lang.String DE_DATE_FORMAT
```
    The DE language date format.
    
    See Also:
    Constant Field Values
  - OTHER_DATE_FORMAT
```
public static final java.lang.String OTHER_DATE_FORMAT
```
    The other language date format.
    
    See Also:
    Constant Field Values
  - FLAGS_AS_BITS
```
public static final boolean FLAGS_AS_BITS
```
  - FLAG_FILLER
```
protected static final java.lang.String FLAG_FILLER
```
    See Also:
    Constant Field Values
  - deLang
```
public static boolean deLang
```
- Method Detail
  - getVersion
```
public static java.lang.String getVersion()
```
  - getVersion
```
public static java.lang.String getVersion(InstanceElement instance)
```
    Return the version string of an instance element.
    
    Parameters:
    instance - the instance.
    
    Returns:
    the version string.
  - escapePattern
```
public static java.lang.String escapePattern(java.lang.String pattern)
```
    Return the pattern with the special pattern characters escaped.
    
    Parameters:
    the - string.
    
    Returns:
    the pattern.
  - isIndependent
```
public static boolean isIndependent(InstanceElement column)
```
    Return a boolean whether the given local column is defined as independent.
    
    Parameters:
    column - the instance of the type AoLocalColumn.
    
    Returns:
    true if the given local column is defined as independent.
  - getFlags
```
public static short[] getFlags(InstanceElement column)
```
    Get the flags of a column.
    
    Parameters:
    column - the local column.
    
    Returns:
    an array containing the flags of a column.
  - isImplicit
```
public static long isImplicit(InstanceElement column)
```
    return a boolean whether the column is independent.
    
    Parameters:
    column - the local column.
    
    Returns:
    true if the column is indpendent.
  - getRating
```
public static double[] getRating(InstanceElement column)
```
    Get the rating of an independent column.
    
    Returns:
    an array containing the rating.
  - setAttributes
```
public static void setAttributes(InstanceElement ieObj,
                 java.util.Map attrs)
                          throws AoException
```
    Set the attributes of an instance element according to the given map.
    
    Parameters:
    ieObj - the instance element.
    attrs - the map containing the attribues. The keyword must be equal to the base attributes name or equal to the application attribute name.
    
    Throws:
    
    AoException
  - severityFlagToString
```
public static java.lang.String severityFlagToString(SeverityFlag sevFlag)
```
    Get the string of the SeverityFlag.
    
    Parameters:
    sevFlag - the severity flag.
    
    Returns:
    the string, which represent the severity flag.
  - aoExceptionToString
```
public static java.lang.String aoExceptionToString(AoException aoException)
```
    Get the string of the AoException.
    
    Parameters:
    aoException - the exception.
    
    Returns:
    the string, which represent the AoException.
  - flagsToString
```
public static java.lang.String flagsToString(short flag)
```
    Get the flag string.
    
    Parameters:
    flag - the value flag.
    
    Returns:
    the flag string.
  - getTypeSize
```
public static int getTypeSize(int datatype)
```
    Get the type size of a ODS value.
    
    Parameters:
    datatype - The data type int representation.
    
    Returns:
    ods compatible type size.
  - getTypeSize
```
public static int getTypeSize(DataType datatype)
```
    Get the type size of a ODS value.
    
    Parameters:
    datatype - The data type.
    
    Returns:
    ods compatible type size.
  - getTypeSize
```
public static int getTypeSize(TS_Value value)
```
    Get the type size of a ODS value.
    
    Parameters:
    value - instance of TS_Value
    
    Returns:
    ods compatible type size.
  - createNameValueUnit
```
public static NameValueUnit createNameValueUnit(java.lang.String name,
                                DataType datatype,
                                java.lang.String unit)
```
    Create a name value unit. The flag of the TS_Union will ve set to VALID.
    
    Parameters:
    name - The name to the NameValueUnit object.
    datatype - The data type of the NameValueUnit object.
    unit - The unit of the name value unit.
  - clone
```
public static T_LONGLONG clone(T_LONGLONG val)
```
    Clone a T_LONGLONG value.
    
    Parameters:
    val - The value.
    
    Returns:
    the cloned value.
  - clone
```
public static T_COMPLEX clone(T_COMPLEX val)
```
    Clone a T_COMPLEX value.
    
    Parameters:
    val - The value.
    
    Returns:
    the cloned value.
  - clone
```
public static T_DCOMPLEX clone(T_DCOMPLEX val)
```
    Clone a T_DCOMPLEX value.
    
    Parameters:
    val - The value.
    
    Returns:
    the cloned value.
  - clone
```
public static T_ExternalReference clone(T_ExternalReference val)
```
    Clone a T_ExternalReference value.
    
    Parameters:
    val - The value.
    
    Returns:
    the cloned value.
  - clone
```
public static byte[] clone(byte[] val)
```
    Clone a byte sequence value.
    
    Parameters:
    val - The value.
    
    Returns:
    the cloned value.
  - clone
```
public static java.lang.String[] clone(java.lang.String[] val)
```
    Clone a string sequence value.
    
    Parameters:
    val - The value.
    
    Returns:
    the cloned value.
  - clone
```
public static short[] clone(short[] val)
```
    Clone a short sequence value.
    
    Parameters:
    val - The value.
    
    Returns:
    the cloned value.
  - clone
```
public static float[] clone(float[] val)
```
    Clone a float sequence value.
    
    Parameters:
    val - The value.
    
    Returns:
    the cloned value.
  - clone
```
public static boolean[] clone(boolean[] val)
```
    Clone a boolean sequence value.
    
    Parameters:
    val - The value.
    
    Returns:
    the cloned value.
  - clone
```
public static int[] clone(int[] val)
```
    Clone a long sequence value.
    
    Parameters:
    val - The value.
    
    Returns:
    the cloned value.
  - clone
```
public static double[] clone(double[] val)
```
    Clone a double sequence value.
    
    Parameters:
    val - The value.
    
    Returns:
    the cloned value.
  - clone
```
public static T_LONGLONG[] clone(T_LONGLONG[] val)
```
    Clone a T_LONGLONG sequence value.
    
    Parameters:
    val - The value.
    
    Returns:
    the cloned value.
  - clone
```
public static T_COMPLEX[] clone(T_COMPLEX[] val)
```
    Clone a T_COMPLEX sequence value.
    
    Parameters:
    val - The value.
    
    Returns:
    the cloned value.
  - clone
```
public static T_DCOMPLEX[] clone(T_DCOMPLEX[] val)
```
    Clone a T_DCOMPLEX sequence value.
    
    Parameters:
    val - The value.
    
    Returns:
    the cloned value.
  - clone
```
public static T_ExternalReference[] clone(T_ExternalReference[] val)
```
    Clone a T_ExternalReference sequence value.
    
    Parameters:
    val - The value.
    
    Returns:
    the cloned value.
  - clone
```
public static byte[][] clone(byte[][] val)
```
    Clone a byte stream sequence value.
    
    Parameters:
    val - The value.
    
    Returns:
    the cloned value.
  - clone
```
public static Blob clone(Blob val)
```
    Clone a blob value.
    
    Parameters:
    val - The value.
    
    Returns:
    the cloned value.
  - clone
```
public static NameValueUnit clone(NameValueUnit nvu)
```
    Clone a name value unit.
    
    Parameters:
    nvu - The name value unit to be cloned.
    
    Returns:
    the cloned name value unit.
  - datatypeToString
```
public static java.lang.String datatypeToString(DataType dt)
```
    This method returns the value of a DataType as a string.
    
    Parameters:
    dt - The datatype.
    
    Returns:
    The string of the DataType.
  - parseLongLong
```
public static T_LONGLONG parseLongLong(java.lang.String value)
```
    Parse a T_LONGLONG string value.
    
    Returns:
    the T_LONGLONG belongs to the given string.
  - parseComplex
```
public static T_COMPLEX parseComplex(java.lang.String value)
```
    Parse a T_COMPLEX string value.
    
    Returns:
    the T_COMPLEX belongs to the given string.
  - parseDComplex
```
public static T_DCOMPLEX parseDComplex(java.lang.String value)
```
    Parse a T_DCOMPLEX string value.
    
    Returns:
    the T_DCOMPLEX belongs to the given string.
  - parseBoolean
```
public static boolean parseBoolean(java.lang.String value)
```
    Parse a boolean string value.
    
    Returns:
    the boolean belongs to the given string.
  - parseNameValueUnit
```
public static NameValueUnit parseNameValueUnit(NameValueUnit nvu,
                               java.lang.String value)
                                        throws java.lang.RuntimeException,
                                               AoException
```
    This method returns the value of a TS_Union structure as a string.
    
    Parameters:
    dt - The datatype to be parsed.
    value, - The string to be parsed.
    
    Returns:
    The string of the TS_Union.
    
    Throws:
    
    java.lang.RuntimeException
    
    AoException
  - createNameValueUnit
```
public static NameValueUnit createNameValueUnit(java.lang.String name,
                                java.lang.String unit,
                                DataType dt,
                                java.lang.String value)
                                         throws java.lang.RuntimeException,
                                                AoException
```
    This method creates a name value unit parsing the given string according to the given datatype.
    
    Parameters:
    name - the name of the structure to be created.
    unit - the unist string of the structure.
    dt - The datatype to be parsed.
    value, - The string to be parsed.
    
    Returns:
    The string of the TS_Union.
    
    Throws:
    
    java.lang.RuntimeException
    
    AoException
  - parseTS_Union
```
public static TS_Union parseTS_Union(DataType dt,
                     java.lang.String value)
                              throws java.lang.RuntimeException,
                                     AoException
```
    This method returns the value of a TS_Union structure as a string.
    
    Parameters:
    dt - The datatype to be parsed.
    value, - The string to be parsed.
    
    Returns:
    The string of the TS_Union.
    
    Throws:
    
    java.lang.RuntimeException
    
    AoException
  - parseTS_Union
```
public static TS_Union parseTS_Union(DataType dt,
                     java.lang.String[] value)
                              throws java.lang.RuntimeException,
                                     AoException
```
    This method returns the value of a TS_Union structure as a string array.
    
    Parameters:
    dt - The datatype to be parsed.
    value, - The string array to be parsed.
    
    Returns:
    The string of the TS_Union.
    
    Throws:
    
    java.lang.RuntimeException
    
    AoException
  - parseTS_UnionSeq
```
public static TS_UnionSeq parseTS_UnionSeq(DataType dt,
                           java.lang.String[] value)
                                    throws java.lang.RuntimeException,
                                           AoException
```
    Throws:
    
    java.lang.RuntimeException
    
    AoException
  - valToString
```
public static java.lang.String valToString(java.lang.String date)
```
    This method returns a string presentation of a date value.
    
    Parameters:
    date - the date.
    
    Returns:
    the string presentation.
  - valToString
```
public static java.lang.String valToString(T_LONGLONG val)
```
    This method returns a string presentation of a T_LONGLONG value.
    
    Parameters:
    val - the value.
    
    Returns:
    the string presentation.
  - valToString
```
public static java.lang.String valToString(byte[] val)
```
    This method returns a string presentation of a BYTESTR value.
    
    Parameters:
    val - the value.
    
    Returns:
    the string presentation.
  - valToString
```
public static java.lang.String valToString(T_COMPLEX val)
```
    This method returns a string presentation of a T_COMPLEX value.
    
    Parameters:
    val - the value.
    
    Returns:
    the string presentation.
  - valToString
```
public static java.lang.String valToString(T_DCOMPLEX val)
```
    This method returns a string presentation of a T_DCOMPLEX value.
    
    Parameters:
    val - the value.
    
    Returns:
    the string presentation.
  - valToString
```
public static java.lang.String valToString(T_ExternalReference val)
```
    This method returns a string presentation of a T_ExternalReference value.
    
    Parameters:
    val - the value.
    
    Returns:
    the string presentation.
  - valToString
```
public static java.lang.String valToString(java.lang.Object val)
```
    This method returns a string presentation of a value.
    
    Parameters:
    val - the value.
    
    Returns:
    the string presentation.
  - seqToString
```
public static java.lang.String seqToString(byte[] val)
```
    This method returns a string presentation of a byte sequence value.
    
    Parameters:
    val - the value.
    
    Returns:
    the string presentation.
  - seqToString
```
public static java.lang.String seqToString(byte[] val,
                           int maxCount,
                           boolean multiLine,
                           int lineCount)
```
    This method returns a string presentation of a byte sequence value.
    
    Parameters:
    val - the value.
    maxCount - The maximal count of printed sequence elements.
    multiLine - If true the method will break lines.
    lineCount - Total number of elements per line.
    
    Returns:
    the string presentation.
  - seqToString
```
public static java.lang.String seqToString(byte[] val,
                           int maxCount,
                           boolean multiLine,
                           int lineCount,
                           java.lang.String terminator)
```
    This method returns a string presentation of a byte sequence value.
    
    Parameters:
    val - the value.
    maxCount - The maximal count of printed sequence elements.
    multiLine - If true the method will break lines.
    lineCount - Total number of elements per line.
    
    Returns:
    the string presentation.
  - seqToString
```
public static java.lang.String seqToString(short[] val)
```
    This method returns a string presentation of a short sequence value.
    
    Parameters:
    val - the value.
    
    Returns:
    the string presentation.
  - seqToString
```
public static java.lang.String seqToString(short[] val,
                           int maxCount,
                           boolean multiLine,
                           int lineCount)
```
    This method returns a string presentation of a short sequence value.
    
    Parameters:
    val - the value.
    maxCount - The maximal count of printed sequence elements.
    multiLine - If true the method will break lines.
    lineCount - Total number of elements per line.
    
    Returns:
    the string presentation.
  - seqToString
```
public static java.lang.String seqToString(boolean[] val)
```
    This method returns a string presentation of a boolean sequence value.
    
    Parameters:
    val - the value.
    
    Returns:
    the string presentation.
  - seqToString
```
public static java.lang.String seqToString(boolean[] val,
                           int maxCount,
                           boolean multiLine,
                           int lineCount)
```
    This method returns a string presentation of a boolean sequence value.
    
    Parameters:
    val - the value.
    maxCount - The maximal count of printed sequence elements.
    multiLine - If true the method will break lines.
    lineCount - Total number of elements per line.
    
    Returns:
    the string presentation.
  - seqToString
```
public static java.lang.String seqToString(int[] val)
```
    This method returns a string presentation of a int sequence value.
    
    Parameters:
    val - the value.
    
    Returns:
    the string presentation.
  - seqToString
```
public static java.lang.String seqToString(int[] val,
                           int maxCount,
                           boolean multiLine,
                           int lineCount)
```
    This method returns a string presentation of a int sequence value.
    
    Parameters:
    val - the value.
    maxCount - The maximal count of printed sequence elements.
    multiLine - If true the method will break lines.
    lineCount - Total number of elements per line.
    
    Returns:
    the string presentation.
  - seqToString
```
public static java.lang.String seqToString(float[] val)
```
    This method returns a string presentation of a float sequence value.
    
    Parameters:
    val - the value.
    
    Returns:
    the string presentation.
  - seqToString
```
public static java.lang.String seqToString(float[] val,
                           int maxCount,
                           boolean multiLine,
                           int lineCount)
```
    This method returns a string presentation of a float sequence value.
    
    Parameters:
    val - the value.
    maxCount - The maximal count of printed sequence elements.
    multiLine - If true the method will break lines.
    lineCount - Total number of elements per line.
    
    Returns:
    the string presentation.
  - seqToString
```
public static java.lang.String seqToString(double[] val)
```
    This method returns a string presentation of a double sequence value.
    
    Parameters:
    val - the value.
    
    Returns:
    the string presentation.
  - seqToString
```
public static java.lang.String seqToString(double[] val,
                           int maxCount,
                           boolean multiLine,
                           int lineCount)
```
    This method returns a string presentation of a double sequence value.
    
    Parameters:
    val - the value.
    maxCount - The maximal count of printed sequence elements.
    multiLine - If true the method will break lines.
    lineCount - Total number of elements per line.
    
    Returns:
    the string presentation.
  - seqToString
```
public static java.lang.String seqToString(Blob val)
```
    This method returns a string presentation of a blob value.
    
    Parameters:
    val - the value.
    
    Returns:
    the string presentation.
  - seqToString
```
public static java.lang.String seqToString(Blob blob,
                           int maxCount,
                           boolean multiLine,
                           int lineCount)
```
    This method returns a string presentation of a blob value.
    
    Parameters:
    blob - the value.
    maxCount - The maximal count of printed sequence elements.
    multiLine - If true the method will break lines.
    lineCount - Total number of elements per line.
    
    Returns:
    the string presentation.
  - seqToString
```
public static java.lang.String seqToString(java.lang.String[] val)
```
    This method returns a string presentation of a string sequence value.
    
    Parameters:
    val - the value.
    
    Returns:
    the string presentation.
  - seqToString
```
public static java.lang.String seqToString(java.lang.String[] val,
                           int maxCount,
                           boolean multiLine,
                           int lineCount)
```
    This method returns a string presentation of a string sequence value.
    
    Parameters:
    val - the value.
    maxCount - The maximal count of printed sequence elements.
    multiLine - If true the method will break lines.
    lineCount - Total number of elements per line.
    
    Returns:
    the string presentation.
  - seqToString
```
public static java.lang.String seqToString(java.lang.Object[] val)
```
    This method returns a string presentation of a sequence value.
    
    Parameters:
    val - the value.
    
    Returns:
    the string presentation.
  - seqToString
```
public static java.lang.String seqToString(java.lang.Object[] val,
                           int maxCount,
                           boolean multiLine,
                           int lineCount)
```
    This method returns a string presentation of a sequence value.
    
    Parameters:
    val - the value.
    maxCount - The maximal count of printed sequence elements.
    multiLine - If true the method will break lines.
    lineCount - Total number of elements per line.
    
    Returns:
    the string presentation.
  - seqToString
```
public static java.lang.String seqToString(T_ExternalReference[] val)
```
    This method returns a string presentation of a sequence value.
    
    Parameters:
    val - the value.
    
    Returns:
    the string presentation.
  - seqToString
```
public static java.lang.String seqToString(T_ExternalReference[] val,
                           int maxCount,
                           boolean multiLine,
                           int lineCount)
```
    This method returns a string presentation of a sequence value.
    
    Parameters:
    val - the value.
    maxCount - The maximal count of printed sequence elements.
    multiLine - If true the method will break lines.
    lineCount - Total number of elements per line.
    
    Returns:
    the string presentation.
  - ts_valueSeqToString
```
public static java.lang.String ts_valueSeqToString(TS_ValueSeq ts)
```
    This method returns the value of a TS_ValueSeq structure as a string.
    
    Parameters:
    ts - The TS_ValueSeq structure.
    
    Returns:
    The string of the TS_ValueSeq.
  - ts_valueToString
```
public static java.lang.String ts_valueToString(TS_Value ts)
```
    This method returns the value of a TS_Value structure as a string.
    
    Parameters:
    ts - The TS_Value structure.
    
    Returns:
    The string of the TS_Value.
  - ts_unionToString
```
public static java.lang.String ts_unionToString(TS_Union ts)
```
    This method returns the value of a TS_Union structure as a string.
    
    Parameters:
    ts - The TS_Union structure.
    
    Returns:
    The string of the TS_Union.
  - ts_unionToString
```
public static java.lang.String ts_unionToString(TS_Union ts,
                                int maxCount)
```
    This method returns the value of a TS_Union structure as a string.
    
    Parameters:
    ts - The TS_Union structure.
    maxCount - The maximal count of printed sequence elements.
    
    Returns:
    The string of the TS_Union.
  - ts_unionToString
```
public static java.lang.String ts_unionToString(TS_Union ts,
                                int maxCount,
                                boolean multiLine,
                                int lineCount)
```
    This method returns the value of a TS_Union structure as a string.
    
    Parameters:
    ts - The TS_Union structure.
    maxCount - The maximal count of printed sequence elements.
    multiLine - If true the method will break lines.
    lineCount - Total number of elements per line.
    
    Returns:
    The string of the TS_Union.
  - ts_unionSeqToString
```
public static java.lang.String ts_unionSeqToString(TS_UnionSeq ts)
```
    This method returns the value of a TS_UnionSeq structure as a string.
    
    Parameters:
    ts - The TS_UnionSeq structure.
    
    Returns:
    The string of the TS_UnionSeq.
  - ts_unionSeqToString
```
public static java.lang.String ts_unionSeqToString(TS_UnionSeq ts,
                                   int maxCount)
```
    This method returns the value of a TS_UnionSeq structure as a string.
    
    Parameters:
    ts - The TS_UnionSeq structure.
    maxCount - The maximal count of printed sequence elements.
    
    Returns:
    The string of the TS_UnionSeq.
  - ts_unionSeqToString
```
public static java.lang.String ts_unionSeqToString(TS_UnionSeq ts,
                                   int maxCount,
                                   boolean multiLine,
                                   int lineCount)
```
    This method returns the value of a TS_UnionSeq structure as a string.
    
    Parameters:
    ts - The TS_UnionSeq structure.
    maxCount - The maximal count of printed sequence elements.
    multiLine - If true the method will break lines.
    lineCount - Total number of elements per line.
    
    Returns:
    The string of the TS_UnionSeq.
  - nameValueUnitToString
```
public static java.lang.String nameValueUnitToString(NameValueUnit nvu)
```
    This method returns the value of a NameValueUnit structure as a string.
    
    Parameters:
    nvu - The NameValueUnit structure.
    
    Returns:
    The NameValueUnit as a string.
  - nameValueSeqUnitToString
```
public static java.lang.String nameValueSeqUnitToString(NameValueSeqUnit nvu)
```
    This method returns the value of a NameValueSeqUnit structure as a string.
    
    Parameters:
    nvu - The NameValueSeqUnit structure.
    
    Returns:
    The NameValueSeqUnit as a string.
  - nameValueSeqUnitIdToString
```
public static java.lang.String nameValueSeqUnitIdToString(NameValueSeqUnitId nvu)
```
    This method returns the value of a NameValueSeqUnitId structure as a string.
    
    Parameters:
    nvu - The NameValueSeqUnitId structure.
    
    Returns:
    The NameValueSeqUnitId as a string.
  - nameValueToString
```
public static java.lang.String nameValueToString(NameValue nvu)
```
    This method returns the value of a NameValue structure as a string.
    
    Parameters:
    nvu - The NameValue structure.
    
    Returns:
    The NameValue as a string.
  - relationRangeToString
```
public static java.lang.String relationRangeToString(RelationRange relRange)
```
    This method returns the RelationType as a string.
    
    Parameters:
    relRange - The RelationRange.
    
    Returns:
    The relation range as string.
  - relationshipToString
```
public static java.lang.String relationshipToString(Relationship relship)
```
    This method returns the relationship as a string.
    
    Parameters:
    relship - The Relationship.
    
    Returns:
    The relationship as string.
  - relationTypeToString
```
public static java.lang.String relationTypeToString(RelationType relType)
```
    This method returns the RelationType as a string.
    
    Parameters:
    relType - The RelationType.
    
    Returns:
    The relation type as string.
  - applAttrToString
```
public static java.lang.String applAttrToString(ApplAttr aa)
```
    This method returns the ApplAttr as a string.
    
    Parameters:
    aa - The ApplAttr structure.
    
    Returns:
    The ApplAttr as string.
  - applRelToString
```
public static java.lang.String applRelToString(ApplRel ar)
```
    This method returns the ApplRel as a string.
    
    Parameters:
    ar - The ApplRel structure.
    
    Returns:
    The AppRel as string.
  - applElemToString
```
public static java.lang.String applElemToString(ApplElem ae)
```
    This method returns the ApplElem as a string.
    
    Parameters:
    ae - The ApplElem structure.
    
    Returns:
    The ApplElem as string.
  - applicationStructureValueToString
```
public static java.lang.String applicationStructureValueToString(ApplicationStructureValue asStr)
```
    This method returns the ApplicationStructureValue as a string.
    
    Parameters:
    asStr - The ApplicationStructureValue structure.
    
    Returns:
    The ApplicationStructureValue as string.
  - copyInstance
```
public static InstanceElement copyInstance(java.lang.String name,
                           java.lang.String version,
                           java.lang.String description,
                           InstanceElement source,
                           InstanceElement parent)
                                    throws FwkException,
                                           AoException
```
    Copy an instance inside the same session. All relations will be copied, except the relation to the parent.
    
    Parameters:
    name - The name of the new instance.
    version - The version string of the new instance. May be null
    description - The description of the new instance. May be null
    source - The instance element to be copied.
    parent - The parent under that the instance should be copied.
    
    Throws:
    
    FwkException
    
    AoException
  - getHighestVersion
```
public static float getHighestVersion(T_LONGLONG parIId,
                      T_LONGLONG parAId,
                      ApplicationElement aeObj,
                      java.lang.String instanceName)
```
    Get the highest version of instance element.
    
    Parameters:
    parIId - The id of the instance element parent object (may be null).
    parAId - The id of the application element parent object (may be null).
    aeObj - The application element.
    instanceName - The name of the instance element.
    
    Returns:
    A float version number.
  - getHighestVersionString
```
public static java.lang.String getHighestVersionString(T_LONGLONG parIId,
                                       T_LONGLONG parAId,
                                       ApplicationElement aeObj,
                                       java.lang.String instanceName)
```
    Get the highest string version of instance element.
    
    Parameters:
    parIId - The id of the instance element parent object (may be null).
    parAId - The id of the application element parent object (may be null).
    aeObj - The application element.
    instanceName - The name of the instance element.
    
    Returns:
    A float version number.
  - getOdsDate
```
public static java.lang.String getOdsDate(java.util.Date date)
```
    Get the ODS version of the given date.
    
    Parameters:
    date - the date that should be formated to ODS
    
    Returns:
    the date string used by ODS.
  - longToT_longlong
```
public static T_LONGLONG longToT_longlong(long id)
```
    Get T_LONGLONG presentation of a long. The low part in interpreted as unsigned integer.
    
    Parameters:
    id - the long value.
    
    Returns:
    the T_LONGLONG structure
  - t_longlongToLong
```
public static long t_longlongToLong(T_LONGLONG id)
```
    Get long presentation of a T_LONGLONG. The low part in interpreted as unsigned integer.
    
    Parameters:
    id - a T_LONGLONG structure
    
    Returns:
    is long.
  - t_longlongToString
```
public static java.lang.String t_longlongToString(T_LONGLONG id)
```
    Get string presentation of a T_LONGLONG.
    
    Parameters:
    id - a T_LONGLONG structure
    
    Returns:
    is string.
  - t_complexToString
```
public static java.lang.String t_complexToString(T_COMPLEX complex)
```
    Get string presentation of a T_COMPLEX.
    
    Parameters:
    id - a T_LONGLONG structure
    
    Returns:
    is string.
  - t_dcomplexToString
```
public static java.lang.String t_dcomplexToString(T_DCOMPLEX complex)
```
    Get string presentation of a T_DCOMPLEX.
    
    Parameters:
    id - a T_LONGLONG structure
    
    Returns:
    is string.
  - getNameValueUnit
```
public static NameValueUnit getNameValueUnit(java.lang.String name,
                             java.lang.String value)
```
    This static method creates a nameValueUnit with the given name containing the given value
    
    Parameters:
    name - The name of the unit.
    val - The value of the unit.
  - getNameValueUnit
```
public static NameValueUnit getNameValueUnit(java.lang.String name,
                             int value)
```
    This static method creates a nameValueUnit with the given name containing the given value
    
    Parameters:
    name - The name of the unit.
    val - The value of the unit.
  - getNameValueUnit
```
public static NameValueUnit getNameValueUnit(java.lang.String name,
                             short value)
```
    This static method creates a nameValueUnit with the given name containing the given value
    
    Parameters:
    name - The name of the unit.
    val - The value of the unit.
  - getNameValueUnit
```
public static NameValueUnit getNameValueUnit(java.lang.String name,
                             boolean value)
```
    This static method creates a nameValueUnit with the given name containing the given value
    
    Parameters:
    name - The name of the unit.
    val - The value of the unit.
  - getNameValueUnit
```
public static NameValueUnit getNameValueUnit(java.lang.String name,
                             float value)
```
    This static method creates a nameValueUnit with the given name containing the given value
    
    Parameters:
    name - The name of the unit.
    val - The value of the unit.
  - getNameValueUnit
```
public static NameValueUnit getNameValueUnit(java.lang.String name,
                             double value)
```
    This static method creates a nameValueUnit with the given name containing the given value
    
    Parameters:
    name - The name of the unit.
    val - The value of the unit.
  - getNameValueUnit
```
public static NameValueUnit getNameValueUnit(java.lang.String name,
                             byte value)
```
    This static method creates a nameValueUnit with the given name containing the given value
    
    Parameters:
    name - The name of the unit.
    val - The value of the unit.
  - getNameValueUnitDate
```
public static NameValueUnit getNameValueUnitDate(java.lang.String name,
                                 java.lang.String date)
```
    This static method creates a nameValueUnit with the given name containing the given date
    
    Parameters:
    name - The name of the unit.
    date - The value of the unit.
  - getParent
```
public static InstanceElement getParent(InstanceElement ieObj)
```
    Get the parent of an instance element.
    
    Parameters:
    ieObj - the instance element.
    
    Returns:
    the parent of the instance element or null if no parent is defined.
  - getParent
```
public static ApplicationElement getParent(ApplicationElement aeObj)
```
    Get the parent of an instance element.
    
    Parameters:
    ieObj - the instance element.
    
    Returns:
    the parent of the instance element or null if no parent is defined.
  - getChildren
```
public static InstanceElement[] getChildren(InstanceElement ieObj)
```
    Get the children of an instance element.
    
    Parameters:
    ieObj - the instance element.
    
    Returns:
    an array containing the children of the given instance element.
  - getInstancesById
```
public static InstanceElement[] getInstancesById(ApplicationStructure asObj,
                                 ElemId[] ei)
                                          throws AoException
```
    Get the instances by id. This method sorts the outcoming instance array in the order of the incoming ElemIds. None existing instances will be null.
    All InstanceElements must be derived from the same ApplicationElement
    
    Throws:
    
    AoException
  - sortInstancesByElemIds
```
protected static InstanceElement[] sortInstancesByElemIds(InstanceElement[] ieArr,
                                       ElemId[] eiArr)
```
    Sort the given instances by the given ElemIds. This method is useful to create a relation between the input parameters and returned instance elements of the method ApplicationStructure.getInstancesById.
    
    Parameters:
    ieArr - An array of instances.
    eiArr - An array of ElemIds.
    
    Returns:
    An array containing the instances sorted by the elem ids. It is possible that this array has more element with null entries than the input array. null elements are placed to the end of array.
  - DT2DS
```
public static DataType DT2DS(DataType dt)
```
    Return an sequence datatype of the given datatype.
    e.g.: in(DT_INT) -> out(DS_INT)
    
    Parameters:
    dt - the datatype.
    
    Returns:
    the sequence representation of the datatype.
  - DS2DT
```
public static DataType DS2DT(DataType dt)
```
    Return an datatype of the given sequence datatype.
    e.g.: in(DS_INT) -> out(DT_INT)
    
    Parameters:
    dt - the datatype.
    
    Returns:
    the single representation of the datatype.
  - getODSVersion
```
public static java.lang.String getODSVersion(AoSession session)
```
    Get the ods version of the given session.
    
    Parameters:
    the - session.
    
    Returns:
    the ODS version string.
  - getODSVersion
```
public static java.lang.String getODSVersion(OdsxSessionInterface session)
```
    Get the ods version of the given session.
    
    Parameters:
    the - session.
    
    Returns:
    the ODS version string.
  - hasSelfReference
```
public static boolean hasSelfReference(ApplicationElement aeObj)
                                throws AoException
```
    Return a boolean whether the elements ahs a self reference.
    
    Returns:
    true if the element a self reference.
    
    Throws:
    
    AoException
  - getSuperTypeElementByBaseType
```
public static ApplicationElement getSuperTypeElementByBaseType(ApplicationStructure as,
                                               java.lang.String baseType)
                                                        throws AoException
```
    Get the super type element of the ASAM ODS base type. When there are different elements derived from the base type return the first element which has no super type elements. Base types where only one element can be derived from may use inheritance so more elements exist.
    
    Parameters:
    as - the application structure
    baseType - the base type
    
    Returns:
    the first application element without any super type element
    
    Throws:
    
    AoException - any occurring ASAM ODS Exception.
  - main
```
public static void main(java.lang.String[] args)
```
    The main test procedure.

Class OdsxHelper

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

version

ODS_VERSION

ODS_DATE_FORMAT

DE_DATE_FORMAT

OTHER_DATE_FORMAT

FLAGS_AS_BITS

FLAG_FILLER

deLang

Method Detail

getVersion

getVersion

escapePattern

isIndependent

getFlags

isImplicit

getRating

setAttributes

severityFlagToString

aoExceptionToString

flagsToString

getTypeSize

getTypeSize

getTypeSize

createNameValueUnit

clone

clone

clone

clone

clone

clone

clone

clone

clone

clone

clone

clone

clone

clone

clone

clone

clone

clone

datatypeToString

parseLongLong

parseComplex

parseDComplex

parseBoolean

parseNameValueUnit

createNameValueUnit

parseTS_Union

parseTS_Union

parseTS_UnionSeq

valToString

valToString

valToString

valToString

valToString

valToString

valToString

seqToString

seqToString

seqToString

seqToString

seqToString

seqToString

seqToString

seqToString

seqToString

seqToString

seqToString

seqToString

seqToString

seqToString

seqToString

seqToString