com.nt.udc.ndk.node

Class DCField

java.lang.Object

com.nt.udc.ndk.node.DCField

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

ByteField, BytesField, DoubleField, FloatField, IntField, IPField, ListField, LongField, MacField, MapField, MillisField, NullField, ObjectField, SecondsField, ShortField, StringField

public abstract class DCField
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

This is the abstract class for all DCField objects. DCField objects have a binary format as well, for the most part used when writing out to disk or for storage in a byte array. The following is an illustration of the current binary format of a given DCField object: Byte 0 1 2 3 --------------------------------- Word 1: ID ID ID ID Word 2: Type Len Len Len Word 3: Value Value Value Value . . Word n: Value Value Value Value Please note that the length, as it is stored in binary form, is the length of the WHOLE attribute, including the header. (i.e., NOT just the length of the value!) However, the length, as stored in the "LENGTH" constants of the various fields, is the length of the value. A "LENGTH" constant of -1 denotes a variable length.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	ATTR_HEADER_SIZE
static int	BYTE
static int	BYTES
protected int	datatype
static int	DOUBLE
static int	FLOAT
static int	INTEGER
static int	IP
static int	IPV6
static int	LIST
static int	LONG
static int	MAC
static int	MAP
static int	NULL
static int	OBJECT
static int	SHORT
static int	STRING
static int	TIMEINMILLIS
static int	TIMEINSECONDS
static int	UINT128
protected byte[]	value

Constructor Summary

Constructors

Constructor and Description
DCField()
DCField(FieldKey key)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone()
static DCField	create(int type, FieldKey key)
DCField	dup(FieldKey newKey) Given an existing field and a name key name, return a new field with the same type and value as the original, but with the new key.
boolean	equals(DCField oa) Compares the value of this DCField with oa
boolean	equalsValue(DCField comparisonField)
byte[]	getBytes() Deprecated.
byte[]	getBytesValue()
byte	getByteValue()
java.util.Date	getDateValue()
static DCField	getDCField(FieldKey key, int type, byte[] value)
static DCField	getDCField(FieldKey id, int type, java.lang.String value)
static DCField	getDCField(FieldKey id, int type, java.lang.String s, java.lang.String operation, java.lang.String original_value)
double	getDoubleValue()
float	getFloatValue()
java.lang.String	getID()
int	getIntValue()
FieldKey	getKey()
int	getLength() Deprecated. Use isEmpty to determine if field is empty
long	getLongValue()
short	getShortValue()
static int	getStaticAttrLength(int type) Deprecated. types.
java.lang.String	getStringValue()
int	getType()
protected void	init(FieldKey sid, byte[] inValues)
protected void	init(int sid, byte[] inValues) Set the id and value members to the values provided
protected void	init(java.lang.String sid, byte[] inValues) Set the id and value members to the values provided
boolean	isEmpty()
static boolean	isVarLength(int type) Deprecated.
static DCField	makeAttrfromBytes(byte[] attrBytes, int offset) Deprecated.
static DCField	makeAttrfromBytes(FieldKey id, int type, byte[] valueBytes)
static DCField	makeAttrfromBytes(int id, int type, byte[] valueBytes) Deprecated.
static DCField	makeAttrfromBytes(java.lang.String id, int type, byte[] valueBytes) Deprecated. Use makeAttrfromBytes(Fielkey,...)
static DCField	makeAttrfromStream(java.io.DataInputStream dis) Deprecated.
void	readValueFromStream(java.io.InputStream in)
void	setID(int newID) Deprecated.
void	setID(java.lang.String newID) Deprecated.
void	setKey(FieldKey key)
protected void	setType(int t) Sets the type for this DCField object
void	setValue(byte[] valueBytes) Sets the value of this DCField to what is contained in valueBytes
java.lang.String	toString()
int	writeValueToStream(java.io.OutputStream out)

Methods inherited from class java.lang.Object

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

Field Detail

STRING

public static final int STRING

See Also:

Constant Field Values

INTEGER

public static final int INTEGER

See Also:

Constant Field Values

LONG

public static final int LONG

See Also:

Constant Field Values

TIMEINSECONDS

public static final int TIMEINSECONDS

See Also:

Constant Field Values

IP

public static final int IP

See Also:

Constant Field Values

TIMEINMILLIS

public static final int TIMEINMILLIS

See Also:

Constant Field Values

MAC

public static final int MAC

See Also:

Constant Field Values

UINT128

public static final int UINT128

See Also:

Constant Field Values

BYTE

public static final int BYTE

See Also:

Constant Field Values

SHORT

public static final int SHORT

See Also:

Constant Field Values

IPV6

public static final int IPV6

See Also:

Constant Field Values

FLOAT

public static final int FLOAT

See Also:

Constant Field Values

DOUBLE

public static final int DOUBLE

See Also:

Constant Field Values

BYTES

public static final int BYTES

See Also:

Constant Field Values

OBJECT

public static final int OBJECT

See Also:

Constant Field Values

LIST

public static final int LIST

See Also:

Constant Field Values

NULL

public static final int NULL

See Also:

Constant Field Values

MAP

public static final int MAP

See Also:

Constant Field Values

ATTR_HEADER_SIZE

public static final int ATTR_HEADER_SIZE

See Also:

Constant Field Values

value

protected byte[] value

datatype

protected int datatype

Constructor Detail

DCField

public DCField()

DCField

public DCField(FieldKey key)

Method Detail

getByteValue

public byte getByteValue()
                  throws java.lang.ClassCastException

Throws:

java.lang.ClassCastException

getDateValue

public java.util.Date getDateValue()
                            throws java.lang.ClassCastException

Throws:

java.lang.ClassCastException

getDoubleValue

public double getDoubleValue()
                      throws java.lang.ClassCastException

Throws:

java.lang.ClassCastException

getFloatValue

public float getFloatValue()
                    throws java.lang.ClassCastException

Throws:

java.lang.ClassCastException

getIntValue

public int getIntValue()
                throws java.lang.ClassCastException

Throws:

java.lang.ClassCastException

getLongValue

public long getLongValue()
                  throws java.lang.ClassCastException

Throws:

java.lang.ClassCastException

getShortValue

public short getShortValue()
                    throws java.lang.ClassCastException

Throws:

java.lang.ClassCastException

getStringValue

public java.lang.String getStringValue()
                                throws java.lang.ClassCastException

Throws:

java.lang.ClassCastException

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

makeAttrfromStream

public static DCField makeAttrfromStream(java.io.DataInputStream dis)

Deprecated.

Method to make a DCField from the given stream

makeAttrfromBytes

public static DCField makeAttrfromBytes(byte[] attrBytes,
                                        int offset)

Deprecated.

Method to make an DCField from an array of bytes

makeAttrfromBytes

public static DCField makeAttrfromBytes(int id,
                                        int type,
                                        byte[] valueBytes)

Deprecated.

Method to make an DCField from an array of bytes

create

public static DCField create(int type,
                             FieldKey key)

getDCField

public static DCField getDCField(FieldKey id,
                                 int type,
                                 java.lang.String value)

getDCField

public static DCField getDCField(FieldKey key,
                                 int type,
                                 byte[] value)

getDCField

public static DCField getDCField(FieldKey id,
                                 int type,
                                 java.lang.String s,
                                 java.lang.String operation,
                                 java.lang.String original_value)

makeAttrfromBytes

public static DCField makeAttrfromBytes(java.lang.String id,
                                        int type,
                                        byte[] valueBytes)

Deprecated. Use makeAttrfromBytes(Fielkey,...)

makeAttrfromBytes

public static DCField makeAttrfromBytes(FieldKey id,
                                        int type,
                                        byte[] valueBytes)

dup

public DCField dup(FieldKey newKey)

Given an existing field and a name key name, return a new field with the same type and value as the original, but with the new key.

Parameters:

newKey - The key for the new field

Returns:

A new Field with the old value, and new key.

isVarLength

public static final boolean isVarLength(int type)

Deprecated.

Indicates whether the given type is a variable length type

Returns:

true, if type is variable length (of type String)

getStaticAttrLength

public static final int getStaticAttrLength(int type)

Deprecated. types.

This method returns the byte size for static-length Field

init

protected void init(int sid,
                    byte[] inValues)

Set the id and value members to the values provided

init

protected void init(java.lang.String sid,
                    byte[] inValues)

Set the id and value members to the values provided

init

protected void init(FieldKey sid,
                    byte[] inValues)

getBytes

public byte[] getBytes()

Deprecated.

Streams the entire field into a byte array

Returns:

byte array that was generated from this field

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getKey

public final FieldKey getKey()

setKey

public final void setKey(FieldKey key)

getID

public java.lang.String getID()

Returns:

the ID for this DCField object

setID

public void setID(int newID)

Deprecated.

Sets the ID for this DCField object

Parameters:

newID - the id for this DCField object

setID

public void setID(java.lang.String newID)

Deprecated.

Sets the ID for this DCField object

Parameters:

newID - the id for this DCField object

getType

public int getType()

Returns:

the type for this DCField object

setType

protected void setType(int t)

Sets the type for this DCField object

Parameters:

t - the type for this DCField object.

isEmpty

public boolean isEmpty()

getLength

public int getLength()

Deprecated. Use isEmpty to determine if field is empty

Returns:

the length of this DCField's byte array

getBytesValue

public byte[] getBytesValue()

Returns:

a byte array containing the value of this DCField

setValue

public void setValue(byte[] valueBytes)
              throws NDKException

Sets the value of this DCField to what is contained in valueBytes

NOTE: Caveat Machinator (Engineer beware)
At this time, there is no validation of the byte array passed in to this method. The developer should ensure that the bytes used to create this DCField object are appropriate for the specific data type. For example, a byte[] consisting of 7 bytes should not be used to create an IntField object.

Throws:

NDKException

equals

public boolean equals(DCField oa)

Compares the value of this DCField with oa

Returns:

true, if the type and length of this NARField are the same as those for oa

equalsValue

public boolean equalsValue(DCField comparisonField)

writeValueToStream

public int writeValueToStream(java.io.OutputStream out)
                       throws java.io.IOException

Throws:

java.io.IOException

readValueFromStream

public void readValueFromStream(java.io.InputStream in)
                         throws java.io.IOException

Throws:

java.io.IOException