com.tibco.as.space

Class FieldDef

java.lang.Object

com.tibco.as.space.FieldDef

public abstract class FieldDef
extends java.lang.Object

Describes the attributes of the fields that a Tuple stored inside a Space should conform to. Each field has a name and a type. Fields may also have additional attributes such as whether the field is Nullable (i.e. optional).

See Also:

SpaceDef, Tuple

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FieldDef.FieldType

Constructor Summary

Constructors

Constructor and Description
FieldDef()

Method Summary

Modifier and Type	Method and Description
static FieldDef	create(java.lang.String fieldName, FieldDef.FieldType fieldType) Returns a new FieldDef instance
abstract java.lang.String	getName() Returns the field name.
abstract FieldDef.FieldType	getType() Returns the field type.
abstract boolean	isEncrypted() Returns true if the field's value is stored encrypted in memory (optional)
abstract boolean	isNullable() Returns true if the field is nullable (optional).
abstract FieldDef	setEncrypted(boolean isSecured) Marks the field as encrypted in memory (optional).
abstract FieldDef	setNullable(boolean isNullable) Marks the field as being nullable (optional).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FieldDef

public FieldDef()

Method Detail

create

public static FieldDef create(java.lang.String fieldName,
                              FieldDef.FieldType fieldType)

Returns a new FieldDef instance

Parameters:

fieldName - A string uniquely identifying the field.

fieldType - A FieldDef.FieldType value

Returns:

FieldDef the new FieldDef instance

getName

public abstract java.lang.String getName()

Returns the field name.

Returns:

String The field name

getType

public abstract FieldDef.FieldType getType()

Returns the field type.

Returns:

FieldType The field type

isNullable

public abstract boolean isNullable()

Returns true if the field is nullable (optional).

Returns:

boolean true if the field is Nullable, false otherwise

setNullable

public abstract FieldDef setNullable(boolean isNullable)

Marks the field as being nullable (optional).

Parameters:

isNullable - true or false

Returns:

FieldDef This field definition

isEncrypted

public abstract boolean isEncrypted()

Returns true if the field's value is stored encrypted in memory (optional)

Returns:

boolean true if the field is Nullable, false otherwise

setEncrypted

public abstract FieldDef setEncrypted(boolean isSecured)

Marks the field as encrypted in memory (optional).

Parameters:

isSecured - true or false

Returns:

FieldDef This field definition