[Java]: Added semanticType support to IR encoding.

Author: mjpt777

main/java/uk/co/real_logic/sbe/ir/Encoding.java

@@ -23,7 +23,7 @@
 import java.util.concurrent.TimeUnit;
 
 /**
- * Optional settings that can be associated with {@link Token}s.
+ * Optional encoding settings that can be associated with {@link Token}s.
  */
 public class Encoding
 {
@@ -52,6 +52,7 @@ public static enum Presence
  private final String characterEncoding;
  private final String epoch;
  private final TimeUnit timeUnit;
+ private final String semanticType;
 
  public Encoding()
  {
@@ -65,6 +66,7 @@ public Encoding()
  characterEncoding = "";
  epoch = null;
  timeUnit = null;
+ semanticType = null;
  }
 
  public Encoding(final PrimitiveType primitiveType,
@@ -76,7 +78,8 @@ public Encoding(final PrimitiveType primitiveType,
  final PrimitiveValue constVal,
  final String characterEncoding,
  final String epoch,
- final TimeUnit timeUnit)
+ final TimeUnit timeUnit,
+ final String semanticType)
  {
  Verify.notNull(presence, "presence");
  Verify.notNull(byteOrder, "byteOrder");
@@ -91,6 +94,7 @@ public Encoding(final PrimitiveType primitiveType,
  this.characterEncoding = characterEncoding;
  this.epoch = epoch;
  this.timeUnit = timeUnit;
+ this.semanticType = semanticType;
  }
 
  /**
@@ -239,6 +243,16 @@ public TimeUnit timeUnit()
  return timeUnit;
  }
 
+ /**
+ * The semantic type of an encoding which can have relevance to the application layer.
+ *
+ * @return semantic type of an encoding which can have relevance to the application layer.
+ */
+ public String semanticType()
+ {
+ return semanticType;
+ }
+
  public String toString()
  {
  return "Encoding{" +
@@ -252,6 +266,7 @@ public String toString()
  ", characterEncoding='" + characterEncoding + '\'' +
  ", epoch='" + epoch + '\'' +
  ", timeUnit=" + timeUnit +
+ ", semanticType='" + semanticType + '\'' +
  '}';
  }
 
@@ -270,6 +285,7 @@ public static class Builder
  private String characterEncoding = "";
  private String epoch = null;
  private TimeUnit timeUnit = null;
+ private String semanticType = null;
 
  public Builder primitiveType(final PrimitiveType primitiveType)
  {
@@ -331,9 +347,25 @@ public Builder timeUnit(final TimeUnit timeUnit)
  return this;
  }
 
+ public Builder semanticType(final String semanticType)
+ {
+ this.semanticType = semanticType;
+ return this;
+ }
+
  public Encoding build()
  {
- return new Encoding(primitiveType, presence, byteOrder, minVal, maxVal, nullVal, constVal, characterEncoding, epoch, timeUnit);
+ return new Encoding(primitiveType,
+ presence,
+ byteOrder,
+ minVal,
+ maxVal,
+ nullVal,
+ constVal,
+ characterEncoding,
+ epoch,
+ timeUnit,
+ semanticType);
  }
  }
 }

main/java/uk/co/real_logic/sbe/xml/IrGenerator.java

@@ -99,6 +99,8 @@ private void addFieldSignal(final Field field, final Signal signal)
  .name(field.name())
  .schemaId(field.id())
  .version(field.sinceVersion())
+ .encoding(new Encoding.Builder()
+ .semanticType(semanticTypeOf(null, field)).build())
  .build();
 
  tokenList.add(token);
@@ -159,7 +161,9 @@ private void add(final CompositeType type, final int currOffset, final Field fie
  .signal(Signal.BEGIN_COMPOSITE)
  .name(type.name())
  .offset(currOffset)
- .size(type.size());
+ .size(type.size())
+ .encoding(new Encoding.Builder()
+ .semanticType(semanticTypeOf(type, field)).build());
 
  if (field != null)
  {
@@ -183,6 +187,7 @@ private void add(final EnumType type, final int offset, final Field field)
  final PrimitiveType encodingType = type.encodingType();
  final Encoding.Builder encodingBuilder = new Encoding.Builder()
  .primitiveType(encodingType)
+ .semanticType(semanticTypeOf(type, field))
  .byteOrder(byteOrder);
 
  if (type.presence() == Presence.OPTIONAL)
@@ -243,6 +248,7 @@ private void add(final SetType type, final int offset, final Field field)
  .size(encodingType.size())
  .offset(offset)
  .encoding(new Encoding.Builder()
+ .semanticType(semanticTypeOf(type, field))
  .primitiveType(encodingType)
  .build());
 
@@ -289,6 +295,8 @@ private void add(final EncodedDataType type, final int offset, final Field field
  .byteOrder(byteOrder)
  .characterEncoding(type.characterEncoding());
 
+ encodingBuilder.semanticType(semanticTypeOf(type, field));
+
  if (null != field)
  {
  encodingBuilder.epoch(field.epoch());
@@ -332,4 +340,15 @@ private void add(final EncodedDataType type, final int offset, final Field field
 
  tokenList.add(token);
  }
-}
+
+ private String semanticTypeOf(final Type type, final Field field)
+ {
+ final String typeSemanticType = null != type ? type.semanticType() : null;
+ if (typeSemanticType != null)
+ {
+ return typeSemanticType;
+ }
+
+ return null != field ? field.semanticType() : null;
+ }
+}