MetaDataNode (OnixS CME iLink3 Handler Parent 1.1.0 API)

java.lang.Object
- biz.onixs.sbe.def.MetaDataNode

public class MetaDataNode
extends Object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Integer`	`getArrayLength()` Array length.
`biz.onixs.sbe.def.IMetaDataNode`	`getContainer()` Container of the node.
`String`	`getDescription()` SBE description.
`Integer`	`getFixedSize()` Fixed size of the object.
`Integer`	`getId()` SBE id.
`biz.onixs.sbe.def.IMetaDataNode`	`getImplementation()` Node of the implementing type.
`String`	`getMaxValue()` Maximum value.
`String`	`getMinValue()` Minimum value.
`String`	`getName()` SBE name.
`String`	`getNullValue()` Null value.
`Integer`	`getOffset()` Offset.
`String`	`getPresence()` Presence.
`String`	`getPrimitiveTypeName()` Primitive type name.
`String`	`getSemanticType()` Semantic type.
`Integer`	`getSinceVersion()` "sinceVersion" attribute.
`String`	`getValue()` Value.
`boolean`	`isArray()` Checks if the metadata is array definition.
`boolean`	`isComposite()` Checks if the metadata is composite definition.
`boolean`	`isEnum()` Checks if the metadata is enum definition.
`boolean`	`isField()` Checks if the metadata is an SBE field of fieldset.
`boolean`	`isFundamental()` Checks if the metadata is fundamental type.
`boolean`	`isGroup()` Checks if the metadata is repeating group.
`boolean`	`isMessage()` Checks if the metadata is SBE message.
`boolean`	`isSet()` Checks if the metadata is set definition.
`boolean`	`isType()` Checks if the metadata is type definition.
`boolean`	`isTypeMember()` Checks if the node represents type node.
`void`	`setMaxValue(String value)` Update maximum value.
`void`	`setMinValue(String value)` Update minimum value.
`void`	`setNullValue(String value)` Update null value.
`void`	`setValue(String value)` Update value.

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

- Method Detail
  - isMessage
```
public boolean isMessage()
```
    Checks if the metadata is SBE message.
    The method returns true if the metadata node corresponds to the <message> XML node.
    
    Returns:
    
    true if the node is a message.
  - isGroup
```
public boolean isGroup()
```
    Checks if the metadata is repeating group.
    The method returns true if the metadata node corresponds to the <group> XML node.
    The getImplementation() call returns the metadata node that describes the group dimensions ("dimensionType" XML attribute).
    
    Returns:
    
    true if the node is a group.
  - isField
```
public boolean isField()
```
    Checks if the metadata is an SBE field of fieldset.
    The method returns true if the metadata node corresponds to the <field> XML node.
    
    Returns:
    
    true if the node is a field.
  - isType
```
public boolean isType()
```
    Checks if the metadata is type definition.
    The method returns true if the metadata node corresponds to <type>, <enum>, <set> or <composite> XML node.
    
    Returns:
    
    true if the node is a type definition.
  - isComposite
```
public boolean isComposite()
```
    Checks if the metadata is composite definition.
    The method returns true if the metadata node corresponds to the <composite> XML node.
    
    Returns:
    
    true if the node is a composite definition.
  - isSet
```
public boolean isSet()
```
    Checks if the metadata is set definition.
    The method returns true if the metadata node corresponds to the <set> XML node.
    
    Returns:
    
    true if the node is a set definition.
  - isEnum
```
public boolean isEnum()
```
    Checks if the metadata is enum definition.
    The method returns true if the metadata node corresponds to the <enum> XML node.
    
    Returns:
    
    true if the node is a enum definition.
  - isArray
```
public boolean isArray()
```
    Checks if the metadata is array definition.
    The method returns true if the metadata node corresponds to an SBE field or SBE type that is encoded using SBE array format (attribute "length" contains value greater than 1).
    
    Returns:
    
    true if the node is a set definition.
  - isFundamental
```
public boolean isFundamental()
```
    Checks if the metadata is fundamental type.
    The method returns true if the metadata node corresponds to fundamental primitive SBE type (char, intN, uintN).
    
    Returns:
    
    true if the node is a fundamental type definition.
  - isTypeMember
```
public boolean isTypeMember()
```
    Checks if the node represents type node.
    Returns true if the node:
    - Valid value of enumeration.
    - Choice of set.
    - Field of composite type.
    Returns:
    
    true if the node is a member of another type.
  - getContainer
```
public biz.onixs.sbe.def.IMetaDataNode getContainer()
```
    Container of the node.
    Returns node that represents containe rof the given node. That can be an SBE message for the field, etc.
    
    Returns:
    
    Metadata node of the container.
  - getImplementation
```
public biz.onixs.sbe.def.IMetaDataNode getImplementation()
```
    Node of the implementing type.
    
    Returns:
    
    Implementation node.
  - getPrimitiveTypeName
```
public String getPrimitiveTypeName()
```
    Primitive type name.
    
    Returns:
    
    Primitive type name (if applicable).
  - getId
```
public Integer getId()
```
    SBE id.
    
    Returns:
    
    Id that is associated with given node (if applicable).
  - getName
```
public String getName()
```
    SBE name.
    
    Returns:
    
    Name of the given node (if present).
  - getDescription
```
public String getDescription()
```
    SBE description. .
    
    Returns:
    
    Description of the given node (if present).
  - getPresence
```
public String getPresence()
```
    Presence.
    
    Returns:
    
    Presence of the object described by the node.
  - getOffset
```
public Integer getOffset()
```
    Offset.
    
    Returns:
    
    Offset of the SBE object in the containing fieldset of composite (if applicable).
  - getSinceVersion
```
public Integer getSinceVersion()
```
    "sinceVersion" attribute.
    
    Returns:
    
    value of the "sinceVersion" attribute (if present).
  - getFixedSize
```
public Integer getFixedSize()
```
    Fixed size of the object.
    
    Returns:
    
    Size of the object.
  - getArrayLength
```
public Integer getArrayLength()
```
    Array length.
    
    Returns:
    
    Length of the arry (if applicable).
  - getSemanticType
```
public String getSemanticType()
```
    Semantic type.
    
    Returns:
    
    Semantic type of the object.
  - getMinValue
```
public String getMinValue()
```
    Minimum value.
    
    Returns:
    
    Minimum value.
  - setMinValue
```
public void setMinValue(String value)
```
    Update minimum value.
    
    Parameters:
    
    value - New minimum value.
  - getMaxValue
```
public String getMaxValue()
```
    Maximum value.
    
    Returns:
    
    Maximum value.
  - setMaxValue
```
public void setMaxValue(String value)
```
    Update maximum value.
    
    Parameters:
    
    value - New maximum value.
  - getNullValue
```
public String getNullValue()
```
    Null value.
    
    Returns:
    
    Null value.
  - setNullValue
```
public void setNullValue(String value)
```
    Update null value.
    
    Parameters:
    
    value - New null value.
  - getValue
```
public String getValue()
```
    Value.
    Constant value associated with given node.
    
    Returns:
    
    Value.
  - setValue
```
public void setValue(String value)
```
    Update value.
    Updates constant value associated with given node.
    
    Parameters:
    
    value - - the value.

Class MetaDataNode

Method Summary

Methods inherited from class java.lang.Object

Method Detail

isMessage

isGroup

isField

isType

isComposite

isSet

isEnum

isArray

isFundamental

isTypeMember

getContainer

getImplementation

getPrimitiveTypeName

getId

getName

getDescription

getPresence

getOffset

getSinceVersion

getFixedSize

getArrayLength

getSemanticType

getMinValue

setMinValue

getMaxValue

setMaxValue

getNullValue

setNullValue

getValue

setValue