com.nt.udc.nar

Class NAR

java.lang.Object

com.nt.udc.nar.NAR

All Implemented Interfaces:

DCFieldContainer, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

FileEIRecord

public class NAR
extends java.lang.Object
implements DCFieldContainer, java.io.Serializable, java.lang.Cloneable

Used for passing data between Nodes.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	BYTE_ARRAY_TYPE
static int	BYTE_TYPE
static int	DOUBLE_TYPE
static int	FLOAT_TYPE
static int	INT_TYPE
static int	IP_TYPE
static int	LIST_TYPE
static int	LONG_TYPE
static int	MAC_TYPE
static int	MAP_TYPE
static int	NULL_TYPE
static int	OBJECT_TYPE
static int	SHORT_TYPE
static int	STRING_TYPE
static int	TIMEINMILLIS_TYPE
static int	TIMEINSECONDS_TYPE
static int	UINT128_TYPE

Constructor Summary

Constructors

Constructor and Description
NAR()
NAR(byte[] bytes) Creates an NAR, where the NAR is completely in byte form.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAttribute(DCField attr) Deprecated. Use Use setField(DCField)
void	addAttribute(int id, byte value) Deprecated. Use setField(DCField)
void	addAttribute(int id, int value) Deprecated. Use setField(DCField)
void	addAttribute(int id, int type, byte[] value) Deprecated. Use setField(DCField)
void	addAttribute(int id, int type, java.lang.String s) Deprecated. use Use setField(DCField)
void	addAttribute(int id, long value) Deprecated. Use setField(DCField)
void	addAttribute(int id, short value) Deprecated. Use setField(DCField)
void	addAttribute(int id, java.lang.String value) Deprecated. Use setField(DCField)
void	addMillisAttribute(int id, long time) Deprecated. Use setField(DCField)
void	addSecondsAttribute(int id, int time) Deprecated. Use setField(DCField)
java.lang.Object	clone() Creates a copy of this NAR.
void	clone(NAR newnar) Copies this into the given NAR.
boolean	containsAttr(int id) Deprecated. use containsField(FieldKey)
boolean	containsField(FieldKey id)
java.lang.String	convertNarToFormattedString()
java.lang.String	convertNarToString()
java.lang.String	convertNarToString(com.nt.udc.datadictparser.DataDictionary dd) Deprecated.
void	disposeByteArray()
boolean	fieldExist(FieldKey key) A proper implementation of fieldExist().
static NAR	fromBytes(byte[] b)
DCField[]	getAllAttributes() The method to getAttr all DCFields
byte	getAttrAsByte(int id) Gets the byte value of the attribute associated with the specified id.
byte[]	getAttrAsBytes(int id) Deprecated.
java.util.Date	getAttrAsDate(int id) Deprecated. use getField(FieldKey)
double	getAttrAsDouble(int id) Deprecated. use getField(FieldKey)
float	getAttrAsFloat(int id) Deprecated. use getField(FieldKey)
int	getAttrAsInt(int id) Deprecated. use getField(FieldKey)
ListField	getAttrAsList(int id) Deprecated.
long	getAttrAsLong(int id) Deprecated. use getField(FieldKey)
long	getAttrAsMillis(int id) Returns the number of milliseconds since January 1, 1970, 00:00:00 GMT represented by the attribute associated with the specified id.
java.lang.Object	getAttrAsObject(int id) Deprecated.
short	getAttrAsShort(int id) Deprecated. use getField(FieldKey)
java.lang.String	getAttrAsString(int id) Deprecated. use getField(FieldKey)
java.util.Date	getAttrAsTime(int id) Gets the Time value of the attribute associated with the specified id.
DCField	getAttribute(int id) Deprecated. use getField(FieldKey)
DCField	getAttribute(java.lang.String id) Deprecated. use getField(FieldKey)
byte[]	getAttributeValueBytes(FieldKey key) Returns the attribute's value in bytes.
byte[]	getAttributeValueBytes(int id) Deprecated.
byte[]	getAttributeValueBytes(java.lang.String id) Deprecated.
int	getAttrType(int id) Deprecated.
int	getAttrType(java.lang.String id) Gets the type of the attribute associated with the specified id.
DCField	getField(FieldKey id)
DCField	getField(int id) Deprecated. Should use getAttribute(String)
DCField	getField(java.lang.String id) Deprecated. Should use getAttribute(String)
byte[]	getFieldValue(FieldKey key)
byte[]	getFieldValue(int id) Deprecated.
byte[]	getFieldValue(java.lang.String id) Deprecated.
int	getLength()
int	getNumAttrs() The method to getAttr the number of attributes
int	getType(int id)
int	getType(java.lang.String id) Returns the type of the given field.
byte	lookupByte(int attrId) Deprecated.
byte	lookupByte(java.lang.String attrId) Deprecated.
void	lookupDataBytes(int attrId, byte[] barr, int barrOffset) Deprecated.
void	lookupDataBytes(java.lang.String attrId, byte[] barr, int barrOffset) Deprecated.
int	lookupDataLength(int attrId) Deprecated.
int	lookupDataLength(java.lang.String attrId) Deprecated.
int	lookupDataType(int attrId) Deprecated.
int	lookupDataType(java.lang.String attrId) Deprecated. Should use getAttrType instead
double	lookupDouble(int attrId) Deprecated.
double	lookupDouble(java.lang.String attrId) Deprecated.
float	lookupFloat(int attrId) Deprecated.
float	lookupFloat(java.lang.String attrId) Deprecated.
int	lookupInt(int attrId) Deprecated.
int	lookupInt(java.lang.String attrId) Deprecated.
long	lookupLong(int attrId) Deprecated.
long	lookupLong(java.lang.String attrId) Deprecated.
short	lookupShort(int attrId) Deprecated.
short	lookupShort(java.lang.String attrId) Deprecated.
java.lang.String	lookupString(int attrId) Deprecated.
java.lang.String	lookupString(java.lang.String attrId) Deprecated.
void	prepareByteArray() Something for Multithreaded AP (and EP in the future) to use.
boolean	readByteArray(byte[] barray)
boolean	readObject(java.io.InputStream in)
DCField	remove(int id) Deprecated. use remove(FieldKey)
DCField	remove(java.lang.String id) Deprecated. use remove(FieldKey)
DCField	removeAttribute(int id) Deprecated. use removeField(FieldKey)
DCField	removeAttribute(java.lang.String id) Deprecated. use removeField(FieldKey)
DCField	removeField(FieldKey key)
void	setField(DCField field) Sets a field from its DCField form
void	setField(FieldKey attrId, int type, byte[] value)
void	setField(int id, int type, byte[] value) Deprecated. use setField(DCField)
void	setField(java.lang.String fieldId, int type, byte[] value) Sets a field, with the given ID, type and value.
void	shiftAttribute(int oldId, int newId) Deprecated.
int	size()
byte[]	toByteArray() Returns a copy of the NAR's byte array.
java.lang.String	toFormattedString()
java.lang.String	toFormattedString(com.nt.udc.datadictparser.DataDictionary dd)
static NAR[]	toRecArray(byte[] b)
void	toStream(java.io.OutputStream oStream) The method outputs an NAR to the output stream
java.lang.String	toString() Converts the data contained in this object to a String
java.lang.String	toString(com.nt.udc.datadictparser.DataDictionary dd)
void	update(FieldKey key, DCField value)
byte[]	writeByteArray()
int	writeObject(java.io.OutputStream out)

Methods inherited from class java.lang.Object

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

Field Detail

NULL_TYPE

public static final int NULL_TYPE

See Also:

Constant Field Values

BYTE_TYPE

public static final int BYTE_TYPE

See Also:

Constant Field Values

SHORT_TYPE

public static final int SHORT_TYPE

See Also:

Constant Field Values

INT_TYPE

public static final int INT_TYPE

See Also:

Constant Field Values

FLOAT_TYPE

public static final int FLOAT_TYPE

See Also:

Constant Field Values

LONG_TYPE

public static final int LONG_TYPE

See Also:

Constant Field Values

DOUBLE_TYPE

public static final int DOUBLE_TYPE

See Also:

Constant Field Values

BYTE_ARRAY_TYPE

public static final int BYTE_ARRAY_TYPE

See Also:

Constant Field Values

STRING_TYPE

public static final int STRING_TYPE

See Also:

Constant Field Values

TIMEINSECONDS_TYPE

public static final int TIMEINSECONDS_TYPE

See Also:

Constant Field Values

IP_TYPE

public static final int IP_TYPE

See Also:

Constant Field Values

TIMEINMILLIS_TYPE

public static final int TIMEINMILLIS_TYPE

See Also:

Constant Field Values

MAC_TYPE

public static final int MAC_TYPE

See Also:

Constant Field Values

UINT128_TYPE

public static final int UINT128_TYPE

See Also:

Constant Field Values

OBJECT_TYPE

public static final int OBJECT_TYPE

See Also:

Constant Field Values

LIST_TYPE

public static final int LIST_TYPE

See Also:

Constant Field Values

MAP_TYPE

public static final int MAP_TYPE

See Also:

Constant Field Values

Constructor Detail

NAR

public NAR()

NAR

public NAR(byte[] bytes)

Creates an NAR, where the NAR is completely in byte form. (This means the byte array contains the NAR length as well as the attributes).

Parameters:

bytes - bytes of the NAR

Method Detail

clone

public void clone(NAR newnar)

Copies this into the given NAR. This is just another way to do the Cloneable clone() method.

Parameters:

newnar - Empty, or NAR being updated

clone

public java.lang.Object clone()

Creates a copy of this NAR. For use with the Cloneable interface.

Specified by:

clone in interface DCFieldContainer

Overrides:

clone in class java.lang.Object

Returns:

new NAR

toStream

public void toStream(java.io.OutputStream oStream)
              throws java.io.IOException

The method outputs an NAR to the output stream

Parameters:

oStream - output stream to write the NAR to

Throws:

java.io.IOException

toByteArray

public final byte[] toByteArray()

Returns a copy of the NAR's byte array.

Specified by:

toByteArray in interface DCFieldContainer

Returns:

NAR, in byte form

addAttribute

public final void addAttribute(int id,
                byte value)

Deprecated. Use setField(DCField)

addAttribute

public final void addAttribute(int id,
                short value)

Deprecated. Use setField(DCField)

addAttribute

public final void addAttribute(int id,
                int value)

Deprecated. Use setField(DCField)

addAttribute

public final void addAttribute(int id,
                long value)

Deprecated. Use setField(DCField)

addAttribute

public final void addAttribute(int id,
                java.lang.String value)

Deprecated. Use setField(DCField)

addMillisAttribute

public void addMillisAttribute(int id,
                      long time)

Deprecated. Use setField(DCField)

Add a TIMEINMILLIS attribute to the NAR. If there is an attribute already associated with id, its value is replaced.

Parameters:

id - the id of the attribute

time - the time in milliseconds value of the attribute

addSecondsAttribute

public void addSecondsAttribute(int id,
                       int time)

Deprecated. Use setField(DCField)

Add a TIMEINSECONDS attribute to the NAR. If there is an attribute already associated with id, its value is replaced.

Parameters:

id - the id of the attribute

time - the time in seconds value of the attribute

addAttribute

public final void addAttribute(int id,
                int type,
                java.lang.String s)

Deprecated. use Use setField(DCField)

addAttribute

public final void addAttribute(int id,
                int type,
                byte[] value)

Deprecated. Use setField(DCField)

addAttribute

public final void addAttribute(DCField attr)

Deprecated. Use Use setField(DCField)

shiftAttribute

public void shiftAttribute(int oldId,
                  int newId)

Deprecated.

Change an attribute's ID to a new ID.

Parameters:

oldId - Old attribute ID

newId - New attribute ID

removeAttribute

public DCField removeAttribute(int id)

Deprecated. use removeField(FieldKey)

This method removes an attribute with the given id.

Parameters:

id - id of the attribute

Returns:

DCField object, of the id

removeAttribute

public DCField removeAttribute(java.lang.String id)

Deprecated. use removeField(FieldKey)

This method removes an attribute with the given id.

Parameters:

id - id of the attribute

Returns:

DCField object, of the id

removeField

public DCField removeField(FieldKey key)

remove

public DCField remove(int id)

Deprecated. use remove(FieldKey)

Parameters:

id -

Returns:

remove

public DCField remove(java.lang.String id)

Deprecated. use remove(FieldKey)

Parameters:

id -

Returns:

getAttribute

public DCField getAttribute(int id)

Deprecated. use getField(FieldKey)

The method to getAttr an DCField object with tag

Parameters:

id - id of the attribute

Returns:

DCField object, of the id

getAttribute

public DCField getAttribute(java.lang.String id)

Deprecated. use getField(FieldKey)

The method to getAttr an DCField object with tag

Parameters:

id - id of the attribute

Returns:

DCField object, of the id

getAllAttributes

public DCField[] getAllAttributes()

The method to getAttr all DCFields

Returns:

array of DCField objects

getAttributeValueBytes

public byte[] getAttributeValueBytes(java.lang.String id)

Deprecated.

Returns the attribute's value in bytes.

Parameters:

id - id of the attribute

Returns:

the bytes of the attribute's value

getAttributeValueBytes

public byte[] getAttributeValueBytes(FieldKey key)

Returns the attribute's value in bytes.

getAttributeValueBytes

public byte[] getAttributeValueBytes(int id)

Deprecated.

Parameters:

id -

Returns:

containsAttr

public boolean containsAttr(int id)

Deprecated. use containsField(FieldKey)

Tests if there is an attribute with the specified id in this NAR.

Parameters:

id - the id of the attribute

Returns:

true if an attribute with the given id exists in this NAR; false otherwise

containsField

public boolean containsField(FieldKey id)

getAttrType

public int getAttrType(java.lang.String id)

Gets the type of the attribute associated with the specified id.

Parameters:

id - the id of the attribute

Returns:

the type that is associated with the attribute specified by the id; -1 if the id does not identify an attribute in this NAR

getAttrType

public int getAttrType(int id)

Deprecated.

Parameters:

id -

Returns:

getNumAttrs

public int getNumAttrs()

The method to getAttr the number of attributes

Returns:

number of attributes in the NAR

toString

public java.lang.String toString(com.nt.udc.datadictparser.DataDictionary dd)

toString

public java.lang.String toString()

Description copied from interface: DCFieldContainer

Converts the data contained in this object to a String

Specified by:

toString in interface DCFieldContainer

Overrides:

toString in class java.lang.Object

Returns:

String representation of the data

toFormattedString

public java.lang.String toFormattedString(com.nt.udc.datadictparser.DataDictionary dd)

toFormattedString

public java.lang.String toFormattedString()

size

public int size()

convertNarToString

public java.lang.String convertNarToString(com.nt.udc.datadictparser.DataDictionary dd)

Deprecated.

convertNarToFormattedString

public java.lang.String convertNarToFormattedString()

convertNarToString

public java.lang.String convertNarToString()

update

public void update(FieldKey key,
          DCField value)

getAttrAsByte

public byte getAttrAsByte(int id)
                   throws java.lang.NoSuchFieldException,
                          UnsupportedTypeException

Gets the byte value of the attribute associated with the specified id. This method should only be used for BYTE attribute types.

Parameters:

id - the id of the attribute

Returns:

the byte value of the attribute associated with the specified id

Throws:

java.lang.NoSuchFieldException - Thrown when the given id is not found.

UnsupportedTypeException - Thrown when the type of the id cannot be converted to the return type.

getAttrAsBytes

public byte[] getAttrAsBytes(int id)

Deprecated.

Gets the bytes value of the attribute associated with the specified id. This method should only be used for BYTES attribute types.

Parameters:

id - the id of the attribute

Returns:

the bytes value of the attribute associated with the specified id

getAttrAsShort

public short getAttrAsShort(int id)
                     throws java.lang.NoSuchFieldException,
                            UnsupportedTypeException

Deprecated. use getField(FieldKey)

Gets the short value of the attribute associated with the specified id. This method should only be used for SHORT, BYTE, and two byte STRING attribute types.

Parameters:

id - the id of the attribute

Returns:

the short value of the attribute associated with the specified id

Throws:

java.lang.NoSuchFieldException - Thrown when the given id is not found.

UnsupportedTypeException - Thrown when the type of the id cannot be converted to the return type.

getAttrAsInt

public int getAttrAsInt(int id)
                 throws java.lang.NoSuchFieldException,
                        UnsupportedTypeException

Deprecated. use getField(FieldKey)

Gets the integer value of the attribute associated with the specified id. This method should only be used for INTEGER, BYTE, SHORT, IP, TIMEINSECONDS and four byte STRING attribute types.

Parameters:

id - the id of the attribute

Returns:

the integer value of the attribute associated with the specified id

Throws:

java.lang.NoSuchFieldException - Thrown when the given id is not found.

UnsupportedTypeException - Thrown when the type of the id cannot be converted to the return type.

getAttrAsLong

public long getAttrAsLong(int id)
                   throws java.lang.NoSuchFieldException,
                          UnsupportedTypeException

Deprecated. use getField(FieldKey)

Gets the long value of the attribute associated with the specified id. This method should only be used for LONG, BYTE, SHORT, INTEGER, TIMEINSECONDS IP, FLOAT, TIMEINMILLIS, MAC, DOUBLE and eight byte STRING attribute types.

Parameters:

id - the id of the attribute

Returns:

the long value of the attribute associated with the specified id

Throws:

java.lang.NoSuchFieldException - Thrown when the given id is not found.

UnsupportedTypeException - Thrown when the type of the id cannot be converted to the return type.

getAttrAsFloat

public float getAttrAsFloat(int id)
                     throws java.lang.NoSuchFieldException,
                            UnsupportedTypeException

Deprecated. use getField(FieldKey)

Gets the float value of the attribute associated with the specified id. This method should only be used for FLOAT, BYTE, SHORT, INTEGER, TIMEINSECONDS and four byte STRING attribute types.

Parameters:

id - the id of the attribute

Returns:

the float value of the attribute associated with the specified id

Throws:

java.lang.NoSuchFieldException - Thrown when the given id is not found.

UnsupportedTypeException - Thrown when the type of the id cannot be converted to the return type.

getAttrAsDouble

public double getAttrAsDouble(int id)
                       throws java.lang.NoSuchFieldException,
                              UnsupportedTypeException

Deprecated. use getField(FieldKey)

Gets the double value of the attribute associated with the specified id. This method should only be used for DOUBLE, BYTE, SHORT, INTEGER, TIMEINSECONDS, FLOAT, TIMEINMILLIS, LONG and eight byte STRING attribute types.

Parameters:

id - the id of the attribute

Returns:

the double value of the attribute associated with the specified id

Throws:

java.lang.NoSuchFieldException - Thrown when the given id is not found.

UnsupportedTypeException - Thrown when the type of the id cannot be converted to the return type.

getAttrAsDate

public java.util.Date getAttrAsDate(int id)
                             throws java.lang.NoSuchFieldException,
                                    UnsupportedTypeException

Deprecated. use getField(FieldKey)

Gets the Date value of the attribute associated with the specified id. This method should only be used for BYTE, SHORT, INTEGER, TIMEINSECONDS, FLOAT, LONG, TIMEINMILLIS, DOUBLE and eight byte STRING attribute types.

Parameters:

id - the id of the attribute

Returns:

the Date value of the attribute associatedi with the specified id

Throws:

java.lang.NoSuchFieldException - Thrown when the given id is not found.

UnsupportedTypeException - Thrown when the type of the id cannot be converted to the return type.

getAttrAsString

public java.lang.String getAttrAsString(int id)
                                 throws java.lang.NoSuchFieldException,
                                        UnsupportedTypeException,
                                        java.io.IOException,
                                        java.lang.ClassNotFoundException

Deprecated. use getField(FieldKey)

Gets the string representation of the attribute associated with the specified id.

Parameters:

id - the id of the attribute

Returns:

a new String object representing the attribute associated with the specified id

Throws:

java.lang.NoSuchFieldException - Thrown when the given id is not found.

UnsupportedTypeException - Thrown when the type of the id cannot be converted to the return type.

java.io.IOException

java.lang.ClassNotFoundException

getAttrAsMillis

public long getAttrAsMillis(int id)
                     throws java.lang.NoSuchFieldException,
                            UnsupportedTypeException

Returns the number of milliseconds since January 1, 1970, 00:00:00 GMT represented by the attribute associated with the specified id. This method should only be used for BYTE, SHORT, INTEGER, TIMEINSECONDS, FLOAT, LONG, TIMEINMILLIS, DOUBLE and eight byte STRING attribute types.

Parameters:

id - the id of the attribute

Returns:

the number of milliseconds since January 1, 1970, 00:00:00 GMT represented by the attribute associated with the specified id

Throws:

java.lang.NoSuchFieldException - Thrown when the given id is not found.

UnsupportedTypeException - Thrown when the type of the id cannot be converted to the return type.

getAttrAsTime

public java.util.Date getAttrAsTime(int id)
                             throws java.lang.NoSuchFieldException,
                                    UnsupportedTypeException

Gets the Time value of the attribute associated with the specified id. This method should only be used for BYTE, SHORT, INTEGER, TIMEINSECONDS, FLOAT, LONG, TIMEINMILLIS, DOUBLE and eight byte STRING attribute types.

Parameters:

id - the id of the attribute

Returns:

the Time value of the attribute associated with the specified id

Throws:

java.lang.NoSuchFieldException - Thrown when the given id is not found.

UnsupportedTypeException - Thrown when the type of the id cannot be converted to the return type.

getAttrAsObject

public java.lang.Object getAttrAsObject(int id)
                                 throws java.lang.NoSuchFieldException,
                                        UnsupportedTypeException

Deprecated.

Gets the OBJECT value of the attribute associated with the specified id. This method should only be used for OBJECT attribute types.

Parameters:

id - the id of the attribute

Returns:

the object value of the attribute associated with the specified id; 0 if the associated attribute type does not support this value request, or if the id does not identify an attribute in this NAR

Throws:

java.lang.NoSuchFieldException

UnsupportedTypeException

getAttrAsList

public ListField getAttrAsList(int id)

Deprecated.

Gets the LIST value of the attribute associated with the specified id. This method should only be used for LIST attribute types.

Parameters:

id - the id of the attribute

Returns:

the object value of the attribute associated with the specified id; 0 if the associated attribute type does not support this value request, or if the id does not identify an attribute in this NAR

getField

public DCField getField(int id)

Deprecated. Should use getAttribute(String)

Gets a field according to it's integer ID

Parameters:

id - field id, in integer format

Returns:

field object

getField

public DCField getField(java.lang.String id)

Deprecated. Should use getAttribute(String)

Gets a field according to it's String ID

Specified by:

getField in interface DCFieldContainer

Parameters:

id - field id, in String format

Returns:

field object

getField

public DCField getField(FieldKey id)

Specified by:

getField in interface DCFieldContainer

getFieldValue

public byte[] getFieldValue(java.lang.String id)

Deprecated.

Gets a field's value according to it's String ID

Specified by:

getFieldValue in interface DCFieldContainer

Parameters:

id - field id, in String format

Returns:

bytes, representing the field's value

getFieldValue

public byte[] getFieldValue(int id)

Deprecated.

Parameters:

id -

Returns:

getFieldValue

public byte[] getFieldValue(FieldKey key)

Specified by:

getFieldValue in interface DCFieldContainer

getType

public int getType(java.lang.String id)

Returns the type of the given field. Types should be defined in DCField.

Specified by:

getType in interface DCFieldContainer

Parameters:

id - field id

Returns:

type of the field, as an integer

getType

public int getType(int id)

setField

public void setField(java.lang.String fieldId,
            int type,
            byte[] value)

Sets a field, with the given ID, type and value.

Specified by:

setField in interface DCFieldContainer

Parameters:

fieldId - field ID, in String form

type - field type, as an integer

value - field value, in byte[] form

setField

public void setField(FieldKey attrId,
            int type,
            byte[] value)

Specified by:

setField in interface DCFieldContainer

setField

public void setField(DCField field)

Sets a field from its DCField form

Specified by:

setField in interface DCFieldContainer

Parameters:

field - field, in DCField form

setField

public void setField(int id,
            int type,
            byte[] value)

Deprecated. use setField(DCField)

Sets a field, with the given ID, type and value.

Specified by:

setField in interface DCFieldContainer

Parameters:

id - field ID, in integer form

type - field type, as an integer

value - field value, in byte[] form

lookupDataType

public int lookupDataType(java.lang.String attrId)
                   throws NonExistentAttributeException

Deprecated. Should use getAttrType instead

Retrieves the type of data stored with a specified id

Parameters:

attrId - Identifier of the desired field

Returns:

int attribute type, e.g. NAR.INT_TYPE, NAR.STRING_TYPE

Throws:

NonExistentAttributeException - if there is no attribute with the given attribute id.

lookupDataLength

public int lookupDataLength(java.lang.String attrId)
                     throws NonExistentAttributeException

Deprecated.

Returns the length of data stored with a specified id expressed in number of bytes.

Parameters:

attrId - Identifier of the desired field

Returns:

int attribute type, e.g. NAR.INT_TYPE, NAR.STRING_TYPE

Throws:

NonExistentAttributeException - if there is no attribute with the given attribute id.

lookupDataBytes

public void lookupDataBytes(java.lang.String attrId,
                   byte[] barr,
                   int barrOffset)
                     throws NonExistentAttributeException

Deprecated.

Retrieves the data stored with a specified id by storing the bytes into a given byte array at the specified offset. This method would throw a run-time exception if the specified array is not large enough to hold all the bytes of the specified data field starting at the given offset.

Parameters:

attrId - Identifier of the desired field

barr - byte array to store the looked up data

barrOffset - offset into the barr array where data will be stored

Throws:

NonExistentAttributeException - if there is no attribute with the given attribute id.

lookupByte

public byte lookupByte(java.lang.String attrId)
                throws NonExistentAttributeException,
                       InvalidAttributeTypeException

Deprecated.

Retrieves an byte field value with the specified id

Parameters:

attrId - Identifier of the desired field

Returns:

byte value stored against attrId

Throws:

NonExistentAttributeException - if there is no attribute with the given attribute id.

InvalidAttributeTypeException - if the attribute stored with the given attribute id is not a byte.

lookupInt

public int lookupInt(java.lang.String attrId)
              throws NonExistentAttributeException,
                     InvalidAttributeTypeException

Deprecated.

Retrieves an int field value with the specified id

Parameters:

attrId - Identifier of the desired field

Returns:

int value stored against attrId

Throws:

NonExistentAttributeException - if there is no attribute with the given attribute id.

InvalidAttributeTypeException - if the attribute stored with the given attribute id is not a int.

lookupShort

public short lookupShort(java.lang.String attrId)
                  throws NonExistentAttributeException,
                         InvalidAttributeTypeException

Deprecated.

Retrieves an short field value with the specified id

Parameters:

attrId - Identifier of the desired field

Returns:

short value stored against attrId

Throws:

NonExistentAttributeException - if there is no attribute with the given attribute id.

InvalidAttributeTypeException - if the attribute stored with the given attribute id is not a short.

lookupLong

public long lookupLong(java.lang.String attrId)
                throws NonExistentAttributeException,
                       InvalidAttributeTypeException

Deprecated.

Retrieves an long field value with the specified id

Parameters:

attrId - Identifier of the desired field

Returns:

long value stored against attrId

Throws:

NonExistentAttributeException - if there is no attribute with the given attribute id.

InvalidAttributeTypeException - if the attribute stored with the given attribute id is not a long.

lookupFloat

public float lookupFloat(java.lang.String attrId)
                  throws NonExistentAttributeException,
                         InvalidAttributeTypeException

Deprecated.

Retrieves a float value with the specified id

Parameters:

attrId - Identifier of the desired field

Returns:

float value stored against attrId

Throws:

NonExistentAttributeException - if there is no attribute with the given attribute id.

InvalidAttributeTypeException - if the attribute stored with the given attribute id is not a float.

lookupDouble

public double lookupDouble(java.lang.String attrId)
                    throws NonExistentAttributeException,
                           InvalidAttributeTypeException

Deprecated.

Retrieves an double field value with the specified id

Parameters:

attrId - Identifier of the desired field

Returns:

double value stored against attrId

Throws:

NonExistentAttributeException - if there is no attribute with the given attribute id.

InvalidAttributeTypeException - if the attribute stored with the given attribute id is not a double.

lookupString

public java.lang.String lookupString(java.lang.String attrId)
                              throws NonExistentAttributeException,
                                     InvalidAttributeTypeException

Deprecated.

Retrieves a String object with the specified id Use lookupDataBytes() instead, if applicable.

Parameters:

attrId - Identifier of the desired field

Returns:

String object stored against attrId

Throws:

NonExistentAttributeException - if there is no attribute with the given attribute id.

InvalidAttributeTypeException - if the attribute stored with the given attribute id is not a String.

lookupDataType

public int lookupDataType(int attrId)

Deprecated.

Retrieves the type of data stored with a specified id

Parameters:

attrId - String identifier of the desired field

Returns:

int attribute type, e.g. NAR.INT_TYPE, NAR.STRING_TYPE

Throws:

NonExistentAttributeException - if there is no attribute with the given attribute id.

lookupDataLength

public int lookupDataLength(int attrId)

Deprecated.

Returns the length of data stored with a specified id expressed in number of bytes.

Parameters:

attrId - String identifier of the desired field

Returns:

int attribute type, e.g. NAR.INT_TYPE, NAR.STRING_TYPE

Throws:

NonExistentAttributeException - if there is no attribute with the given attribute id.

lookupDataBytes

public void lookupDataBytes(int attrId,
                   byte[] barr,
                   int barrOffset)

Deprecated.

Retrieves the data stored with a specified id by storing the bytes into a given byte array at the specified offset. This method would throw a run-time exception if the specified array is not large enough to hold all the bytes of the specified data field starting at the given offset.

Parameters:

attrId - String identifier of the desired field

barr - byte array to store the looked up data

barrOffset - offset into the barr array where data will be stored

Throws:

NonExistentAttributeException - if there is no attribute with the given attribute id.

lookupByte

public byte lookupByte(int attrId)

Deprecated.

Retrieves an byte field value with the specified id

Parameters:

attrId - String identifier of the desired field

Returns:

byte value stored against attrId

Throws:

NonExistentAttributeException - if there is no attribute with the given attribute id.

InvalidAttributeTypeException - if the attribute stored with the given attribute id is not a byte.

lookupInt

public int lookupInt(int attrId)

Deprecated.

Retrieves an int field value with the specified id

Parameters:

attrId - String identifier of the desired field

Returns:

int value stored against attrId

Throws:

NonExistentAttributeException - if there is no attribute with the given attribute id.

InvalidAttributeTypeException - if the attribute stored with the given attribute id is not a int.

lookupShort

public short lookupShort(int attrId)

Deprecated.

Retrieves an short field value with the specified id

Parameters:

attrId - String identifier of the desired field

Returns:

short value stored against attrId

Throws:

NonExistentAttributeException - if there is no attribute with the given attribute id.

InvalidAttributeTypeException - if the attribute stored with the given attribute id is not a short.

lookupLong

public long lookupLong(int attrId)

Deprecated.

Retrieves an long field value with the specified id

Parameters:

attrId - String identifier of the desired field

Returns:

long value stored against attrId

Throws:

NonExistentAttributeException - if there is no attribute with the given attribute id.

InvalidAttributeTypeException - if the attribute stored with the given attribute id is not a long.

lookupFloat

public float lookupFloat(int attrId)

Deprecated.

Retrieves a float value with the specified id

Parameters:

attrId - String identifier of the desired field

Returns:

float value stored against attrId

Throws:

NonExistentAttributeException - if there is no attribute with the given attribute id.

InvalidAttributeTypeException - if the attribute stored with the given attribute id is not a float.

lookupDouble

public double lookupDouble(int attrId)

Deprecated.

Retrieves an double field value with the specified id

Parameters:

attrId - String identifier of the desired field

Returns:

double value stored against attrId

Throws:

NonExistentAttributeException - if there is no attribute with the given attribute id.

InvalidAttributeTypeException - if the attribute stored with the given attribute id is not a double.

lookupString

public java.lang.String lookupString(int attrId)

Deprecated.

Retrieves a String object with the specified id Use lookupDataBytes() instead, if applicable.

Parameters:

attrId - String identifier of the desired field

Returns:

String object stored against attrId

Throws:

NonExistentAttributeException - if there is no attribute with the given attribute id.

InvalidAttributeTypeException - if the attribute stored with the given attribute id is not a String.

writeByteArray

public byte[] writeByteArray()

writeObject

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

Parameters:

out -

Throws:

java.io.IOException

readByteArray

public boolean readByteArray(byte[] barray)

readObject

public boolean readObject(java.io.InputStream in)
                   throws java.io.IOException

Parameters:

in -

Throws:

java.io.IOException

toRecArray

public static NAR[] toRecArray(byte[] b)

fromBytes

public static NAR fromBytes(byte[] b)

getLength

public int getLength()

prepareByteArray

public void prepareByteArray()

Something for Multithreaded AP (and EP in the future) to use. This formats an internal byte array with the serialized version of the NAR, in preparation for output in a separate step. I expect this method to be called in the Field Processor threads, rather than the NARFileWriter (or similar) thread.

disposeByteArray

public void disposeByteArray()

fieldExist

public boolean fieldExist(FieldKey key)

A proper implementation of fieldExist(). fieldExist() used to be implemented by returning (DCFieldContainer.getFieldValue(key) != null) which had a side effect of calling DCField.clone(). This method eliminates the clone().