java.lang.Object

nz.org.riskscape.engine.types.RelationType

All Implemented Interfaces:: ContainingType, Type

public class RelationType extends Object implements Type, ContainingType

Represents a Relation using Riskscape's type system. Gives information about what sort of values the relation will yield via getMemberType().

Field Summary

Fields

Modifier and Type

Field

Description

static final ComplexTypeConstructor

TYPE_CONSTRUCTOR

static final TypeInformation

TYPE_INFORMATION

static final RelationType

WILD

Useful constant that represents a relation of any kind, in as much as a relation with no specific members is going to accept any other relation.
Constructor Summary

Constructors

Constructor

Description

RelationType(Struct memberType)
Method Summary

Modifier and Type

Method

Description

Struct

asStruct()

Object

coerce(Object value)

Attempt to convert the given value in to one represented by this type.

boolean

equals(Object obj)

int

estimateSize(Object entry)

Estimate the number of bytes used to serialize the given value to an output stream.

Object

fromBytes(DataInputStream in)

Type

getContainedType()

Struct

getMemberType()

The Type of values returned from Relation.

int

hashCode()

Class<?>

internalType()

The underlying java class used to represent this type.

void

toBytes(DataOutputStream os, Object toWrite)

String

toString()

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

Methods inherited from interface nz.org.riskscape.engine.types.ContainingType
visit

Methods inherited from interface nz.org.riskscape.engine.types.Type
checkForNull, find, findAllowNull, getUnwrappedType, isA, isNullable, isNumeric, isWrapped, toString, unwrap

Field Details
- TYPE_CONSTRUCTOR
  
  public static final ComplexTypeConstructor TYPE_CONSTRUCTOR
- TYPE_INFORMATION
  
  public static final TypeInformation TYPE_INFORMATION
- WILD
  
  public static final RelationType WILD
  
  Useful constant that represents a relation of any kind, in as much as a relation with no specific members is going to accept any other relation.
Constructor Details
- RelationType
  
  public RelationType(Struct memberType)
Method Details
- coerce
  
  public Object coerce(Object value) throws CoercionException
  
  Description copied from interface: Type
  
  Attempt to convert the given value in to one represented by this type.
  
  Specified by:
  
  coerce in interface Type
  
  Parameters:
  
  value - The value to coerce
  
  Returns:
  
  A value that conforms to this type
  
  Throws:
  
  CoercionException - if the given object can not be converted to something represented by this type
- internalType
  
  public Class<?> internalType()
  
  Description copied from interface: Type
  
  The underlying java class used to represent this type.
  
  Specified by:
  
  internalType in interface Type
- asStruct
  
  public Struct asStruct()
  
  Specified by:
  
  asStruct in interface Type
- estimateSize
  
  public int estimateSize(Object entry)
  
  Description copied from interface: Type
  
  Estimate the number of bytes used to serialize the given value to an output stream.
  
  Specified by:
  
  estimateSize in interface Type
  
  Parameters:
  
  entry - the value of this type to measure. Must be of Type.internalType() or a ClassCastException is going to happen
  
  Returns:
  
  the estimated number of bytes, or zero if no estimation was possible.
- toBytes
  
  public void toBytes(DataOutputStream os, Object toWrite) throws IOException
  
  Specified by:
  
  toBytes in interface Type
  
  Throws:
  
  IOException
- fromBytes
  
  public Object fromBytes(DataInputStream in) throws IOException
  
  Specified by:
  
  fromBytes in interface Type
  
  Throws:
  
  IOException
- equals
  
  public boolean equals(Object obj)
  
  Overrides:
  
  equals in class Object
- hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode in class Object
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object
- getContainedType
  
  public Type getContainedType()
  
  Specified by:
  
  getContainedType in interface ContainingType
  
  Returns:
  
  The type that this ContainingType contains.
- getMemberType
  
  public Struct getMemberType()
  
  The Type of values returned from Relation.

Class RelationType

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface nz.org.riskscape.engine.types.ContainingType

Methods inherited from interface nz.org.riskscape.engine.types.Type

Field Details

TYPE_CONSTRUCTOR

TYPE_INFORMATION

WILD

Constructor Details

RelationType

Method Details

coerce

internalType

asStruct

estimateSize

toBytes

fromBytes

equals

hashCode

toString

getContainedType

getMemberType