UnifiedMetaData (OnixS CME iLink3 Handler Parent 1.1.1 API)

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

```
public class UnifiedMetaData
extends Object
```
Unified, runtime-resolved view of SBE schema metadata used by the OnixS SBE toolkit.
This class aggregates information about messages, fields, composite/enum types, repeating groups, presence and nullability, offsets/sizes, encodings, and domain-specific hints in a single structure that can be consumed by decoders/encoders and higher–level utilities.
Thread-safety: Instances are not guaranteed to be thread-safe unless documented otherwise; treat them as confined to the parsing/building thread.
Terminology:
- Field: a scalar, composite, enum, set, or variable-length value within a message.
- Group: a repeating block of fields; items may be accessed via child metadata nodes.
- Composite: a fixed-layout structure of primitive members.
The instance can represent actual schema members as well as virtual or synthesized fields (e.g., special IDs defined by biz.onixs.sbe.SpecialFieldIds). Usage examples:
```
 // Iterate groups in a message and print their names
 UnifiedMetaData message = ...;
 for (UnifiedMetaData g : message.getGroups()) {
     if (g.isGroup()) {
         System.out.println(g.getName());
     }
 }
 // Print composite member names and primitive types
 UnifiedMetaData field = ...;
 if (field.isComposite()) {
     for (UnifiedMetaData m : field.getCompositeMembers()) {
         System.out.println(m.getName() + ": " + m.getPrimitiveType());
     }
 }
 // Compute offsets within a fixed-length field set
 int running = 0;
 for (UnifiedMetaData f : field.getCompositeMembers()) {
     int off = f.getOffsetInFieldSet(running);
     System.out.println(f.getName() + " @ " + off);
     running = off + f.getSize();
 }
 
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`UnifiedMetaData.Kind`
`static class`	`UnifiedMetaData.Presence`
`static class`	`UnifiedMetaData.PrimitiveType`
`static class`	`UnifiedMetaData.SemanticType`
`static class`	`UnifiedMetaData.WellKnownComposite`

Constructor Summary

Constructors
Constructor and Description

UnifiedMetaData(MessageSchema messageSchema)

Constructors
Constructor and Description
`UnifiedMetaData(MessageSchema messageSchema)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`buildVirtualFields()`
`UnifiedMetaData`	`findCompositeMember(Function<UnifiedMetaData,Boolean> func)`
`UnifiedMetaData`	`findCompositeMember(String name)`
`UnifiedMetaData`	`findField(int tag)`
`UnifiedMetaData`	`findField(String name)`
`UnifiedMetaData`	`findValue(String name)`
`Integer`	`getBlockLength()`
`Integer`	`getCalculatedOffset()`
`String`	`getCharacterEncoding()`
`UnifiedMetaData[]`	`getCompositeMembers()`
`UnifiedMetaData`	`getCompositeMembersContainer()`
`UnifiedMetaData[]`	`getData()`
`String`	`getDescription()`
`String`	`getDimensionTypeName()`
`Integer`	`getExplicitAlignment()`
`Integer`	`getExplicitOffset()`
`int`	`getFieldSetHeaderSize()`
`Integer`	`getFixedSize()`
`UnifiedMetaData[]`	`getFixedSizeBlock()`
`String`	`getFixMessageType()`
`Object`	`getGeneratingData()`
`UnifiedMetaData[]`	`getGroups()`
`String`	`getInheritedName()`
`Class<?>`	`getInternalJavaClass()`
`int`	`getIntValue()`
`UnifiedMetaData.Kind`	`getKind()`
`Integer`	`getLength()`
`long`	`getLongValue()`
`String`	`getMaxValue()`
`MessageSchema`	`getMessageSchema()`
`MetaDataNode`	`getMetaDataNode()`
`String`	`getMinValue()`
`String`	`getName()`
`String`	`getNullValue()`
`int`	`getOffsetInFieldSet(int ownFieldSetOffset)`
`Object`	`getOwnGeneratingData()`
`int`	`getPaddingAfter()`
`int`	`getPaddingBefore()`
`UnifiedMetaData`	`getParent()`
`UnifiedMetaData.Presence`	`getPresence()`
`Class<?>`	`getPresentativeJavaClass()`
`UnifiedMetaData.PrimitiveType`	`getPrimitiveType()`
`String`	`getRawSemanticType()`
`UnifiedMetaData`	`getResolvedDimensionType()`
`UnifiedMetaData`	`getResolvedUnderlayingType()`
`UnifiedMetaData.SemanticType`	`getSemanticType()`
`Integer`	`getSinceVersion()`
`Integer`	`getTag()`
`String`	`getTimeEpoch()`
`String`	`getTimeUnit()`
`UnifiedMetaData`	`getUnderlayingPrimitiveType()` Finds the deepest primitive type if one present.
`String`	`getUnderlayingPrimitiveTypeName()`
`String`	`getUnderlayingType()`
`Long`	`getValidValuesMask()`
`String`	`getValue()`
`Integer`	`getValuePosition()`
`String`	`getValueRef()`
`UnifiedMetaData[]`	`getValues()`
`UnifiedMetaData[]`	`getVirtualFields()`
`UnifiedMetaData.WellKnownComposite`	`getWellKnownComposite()`
`boolean`	`hasVirtualFields()`
`void`	`initGeneratingData(Object object)`
`boolean`	`isArray()`
`boolean`	`isComposite()`
`boolean`	`isConstant()`
`boolean`	`isCustomComposite()`
`boolean`	`isEnum()`
`boolean`	`isFixedLengthField()`
`boolean`	`isGroup()`
`boolean`	`isOffsetsResolved()`
`boolean`	`isOptional()`
`boolean`	`isRequired()`
`boolean`	`isSet()`
`UnifiedMetaData`	`isSimpleFixField()`
`boolean`	`isVarData()`
`boolean`	`isVirtual()`
`void`	`recognizeTypes()`
`void`	`resolveInternalLinks()`
`void`	`resolveOffsets()`
`void`	`resolveValues(MessageSchema schema)`

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

Constructor Detail

UnifiedMetaData

public UnifiedMetaData(MessageSchema messageSchema)

Method Detail

getMetaDataNode
```
public MetaDataNode getMetaDataNode()
```

getTag
```
public Integer getTag()
```

getName
```
public String getName()
```

getInheritedName
```
public String getInheritedName()
```

getDescription
```
public String getDescription()
```

getValue
```
public String getValue()
```

getKind
```
public UnifiedMetaData.Kind getKind()
```

getSinceVersion
```
public Integer getSinceVersion()
```

getRawSemanticType
```
public String getRawSemanticType()
```

getSemanticType

public UnifiedMetaData.SemanticType getSemanticType()

getFixMessageType
```
public String getFixMessageType()
```

getPrimitiveType

public UnifiedMetaData.PrimitiveType getPrimitiveType()

getLength
```
public Integer getLength()
```

getPresence

public UnifiedMetaData.Presence getPresence()

getNullValue
```
public String getNullValue()
```

getMinValue
```
public String getMinValue()
```

getMaxValue
```
public String getMaxValue()
```

getValueRef
```
public String getValueRef()
```

getExplicitOffset
```
public Integer getExplicitOffset()
```

getExplicitAlignment
```
public Integer getExplicitAlignment()
```

getCalculatedOffset
```
public Integer getCalculatedOffset()
```

getPaddingBefore
```
public int getPaddingBefore()
```

getPaddingAfter
```
public int getPaddingAfter()
```

getFixedSize
```
public Integer getFixedSize()
```

getTimeEpoch
```
public String getTimeEpoch()
```

getTimeUnit
```
public String getTimeUnit()
```

getUnderlayingType
```
public String getUnderlayingType()
```

getUnderlayingPrimitiveTypeName

public String getUnderlayingPrimitiveTypeName()

getResolvedUnderlayingType

public UnifiedMetaData getResolvedUnderlayingType()

getParent
```
public UnifiedMetaData getParent()
```

getFixedSizeBlock

public UnifiedMetaData[] getFixedSizeBlock()

getGroups
```
public UnifiedMetaData[] getGroups()
```

getData
```
public UnifiedMetaData[] getData()
```

getCompositeMembers

public UnifiedMetaData[] getCompositeMembers()

getBlockLength
```
public Integer getBlockLength()
```

getDimensionTypeName
```
public String getDimensionTypeName()
```

getResolvedDimensionType

public UnifiedMetaData getResolvedDimensionType()

getValuePosition
```
public Integer getValuePosition()
```

getValues
```
public UnifiedMetaData[] getValues()
```

getValidValuesMask
```
public Long getValidValuesMask()
```

isOffsetsResolved
```
public boolean isOffsetsResolved()
```

getWellKnownComposite

public UnifiedMetaData.WellKnownComposite getWellKnownComposite()

getCharacterEncoding
```
public String getCharacterEncoding()
```

isEnum
```
public boolean isEnum()
```

isSet
```
public boolean isSet()
```

isComposite
```
public boolean isComposite()
```

isCustomComposite
```
public boolean isCustomComposite()
```

getCompositeMembersContainer

public UnifiedMetaData getCompositeMembersContainer()

isVarData
```
public boolean isVarData()
```

isGroup
```
public boolean isGroup()
```

isSimpleFixField

public UnifiedMetaData isSimpleFixField()

isFixedLengthField
```
public boolean isFixedLengthField()
```

isConstant
```
public boolean isConstant()
```

isOptional
```
public boolean isOptional()
```

isVirtual
```
public boolean isVirtual()
```

isRequired
```
public boolean isRequired()
```

getOffsetInFieldSet

public int getOffsetInFieldSet(int ownFieldSetOffset)

getFieldSetHeaderSize
```
public int getFieldSetHeaderSize()
```

isArray
```
public boolean isArray()
```

findCompositeMember

public UnifiedMetaData findCompositeMember(String name)

findCompositeMember

public UnifiedMetaData findCompositeMember(Function<UnifiedMetaData,Boolean> func)

findValue

public UnifiedMetaData findValue(String name)

findField

public UnifiedMetaData findField(String name)

findField

public UnifiedMetaData findField(int tag)

getMessageSchema

public MessageSchema getMessageSchema()

resolveInternalLinks
```
public void resolveInternalLinks()
```

getUnderlayingPrimitiveType
```
public UnifiedMetaData getUnderlayingPrimitiveType()
```
Finds the deepest primitive type if one present.

Returns:

Metadata of the underlaying primitive type, or null if the there is no underlying primitive type.

recognizeTypes
```
public void recognizeTypes()
```

buildVirtualFields
```
public void buildVirtualFields()
```

hasVirtualFields
```
public boolean hasVirtualFields()
```

getVirtualFields

public UnifiedMetaData[] getVirtualFields()

resolveOffsets
```
public void resolveOffsets()
```

resolveValues

public void resolveValues(MessageSchema schema)

getPresentativeJavaClass

public Class<?> getPresentativeJavaClass()

getInternalJavaClass

public Class<?> getInternalJavaClass()

initGeneratingData

public void initGeneratingData(Object object)

getOwnGeneratingData
```
public Object getOwnGeneratingData()
```

getGeneratingData
```
public Object getGeneratingData()
```

getLongValue
```
public long getLongValue()
```

getIntValue
```
public int getIntValue()
```

Class UnifiedMetaData

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UnifiedMetaData

Method Detail

getMetaDataNode

getTag

getName

getInheritedName

getDescription

getValue

getKind

getSinceVersion

getRawSemanticType

getSemanticType

getFixMessageType

getPrimitiveType

getLength

getPresence

getNullValue

getMinValue

getMaxValue

getValueRef

getExplicitOffset

getExplicitAlignment

getCalculatedOffset

getPaddingBefore

getPaddingAfter

getFixedSize

getTimeEpoch

getTimeUnit

getUnderlayingType

getUnderlayingPrimitiveTypeName

getResolvedUnderlayingType

getParent

getFixedSizeBlock

getGroups

getData

getCompositeMembers

getBlockLength

getDimensionTypeName

getResolvedDimensionType

getValuePosition

getValues

getValidValuesMask

isOffsetsResolved

getWellKnownComposite

getCharacterEncoding

isEnum

isSet

isComposite

isCustomComposite

getCompositeMembersContainer

isVarData

isGroup

isSimpleFixField

isFixedLengthField

isConstant

isOptional

isVirtual

isRequired

getOffsetInFieldSet

getFieldSetHeaderSize

isArray

findCompositeMember

findCompositeMember

findValue

findField

findField

getMessageSchema

resolveInternalLinks

getUnderlayingPrimitiveType

recognizeTypes

buildVirtualFields

hasVirtualFields

getVirtualFields

resolveOffsets