com.nt.udc.io

Class COSAR

java.lang.Object

com.nt.udc.io.COSAR

All Implemented Interfaces:

IAttrSource, DCFieldContainer

Deprecated.

Must be migrated to NAR format

public class COSAR
extends java.lang.Object
implements IAttrSource, DCFieldContainer

This class represents an OSAR. It implements IAttrSource and functions as a factory class for COSARAttr objects.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	COSAR.COSAREnum Deprecated. This class is used to enumerate the attributes

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_RECORD_TYPE Deprecated. This constant represents the default record type name.
protected int	m_attrCount Deprecated. This member represents the current attribute count.
protected COSARAttr[]	m_attrs Deprecated. This member is used to store the attributes in the right order.
protected java.util.HashMap	m_map Deprecated. This member is used to store the OSAR attributes.
protected java.lang.String	m_recordType Deprecated. This member represents the record type.
static java.lang.String	RECORD_TYPE_ID Deprecated. This constant represents the field id in OSARs reserved for the record type.
static java.lang.String	RECORD_TYPE_NAME Deprecated. This constant represents the field id in OSARs reserved for the record type.

Constructor Summary

Constructors

Constructor and Description
COSAR() Deprecated.
COSAR(java.lang.String recordType) Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addAttr(COSARAttr attr) Deprecated.
boolean	append(COSAR osar) Deprecated. This function is used to append another COSAR.
java.lang.Object	clone() Deprecated.
COSARAttr	getAttr(java.lang.String key) Deprecated.
COSAR.COSAREnum	getEnum() Deprecated.
DCField	getField(FieldKey key) Deprecated.
DCField	getField(java.lang.String attrId) Deprecated. Retrieves field value with the specified id
byte[]	getFieldValue(FieldKey key) Deprecated.
byte[]	getFieldValue(java.lang.String attrId) Deprecated. Retrieves field value with the specified id
OSAR	getOSAR() Deprecated. This function returns the equivalent OSAR.
java.lang.String	getRecordType() Deprecated.
int	getType(java.lang.String attrId) Deprecated. Retrieves the type of the value stored at the specified id
static COSARAttr	newOSARAttr(OSARecAttr recAttr) Deprecated. This function builds a new COSARAttr based on a OSARecAttr and returns it.
static COSARAttr	newOSARAttr(java.lang.String id, int type) Deprecated. This function builds a new COSARAttr based on the type and returns it.
void	removeAllAttrs() Deprecated. This function removes all attributes from the OSAR.
void	setField(DCField field) Deprecated. Stores a given value at the specified id
void	setField(FieldKey attrId, int type, byte[] value) Deprecated.
void	setField(int attrId, int type, byte[] value) Deprecated. Stores a given value at the specified id
void	setField(java.lang.String attrId, int type, byte[] value) Deprecated. Stores a given value at the specified id
void	setFromOSAR(OSAR osar) Deprecated. This function is used to set the COSAR based on the contents of the OSAR.
void	setRecordType(java.lang.String recordType) Deprecated.
byte[]	toByteArray() Deprecated. Converts the data contained in this object to a byte array
java.lang.String	toString() Deprecated. Converts the data contained in this object to a String

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_RECORD_TYPE

public static final java.lang.String DEFAULT_RECORD_TYPE

Deprecated.

This constant represents the default record type name.

See Also:

Constant Field Values

RECORD_TYPE_ID

public static final java.lang.String RECORD_TYPE_ID

Deprecated.

This constant represents the field id in OSARs reserved for the record type.

See Also:

Constant Field Values

RECORD_TYPE_NAME

public static final java.lang.String RECORD_TYPE_NAME

Deprecated.

This constant represents the field id in OSARs reserved for the record type.

See Also:

Constant Field Values

m_recordType

protected java.lang.String m_recordType

Deprecated.

This member represents the record type.

m_map

protected java.util.HashMap m_map

Deprecated.

This member is used to store the OSAR attributes.

m_attrs

protected COSARAttr[] m_attrs

Deprecated.

This member is used to store the attributes in the right order.

m_attrCount

protected int m_attrCount

Deprecated.

This member represents the current attribute count.

Constructor Detail

COSAR

public COSAR(java.lang.String recordType)
      throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

COSAR

public COSAR()
      throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

Method Detail

getRecordType

public final java.lang.String getRecordType()

Deprecated.

getEnum

public final COSAR.COSAREnum getEnum()

Deprecated.

setRecordType

public final void setRecordType(java.lang.String recordType)

Deprecated.

getAttr

public COSARAttr getAttr(java.lang.String key)

Deprecated.

Specified by:

getAttr in interface IAttrSource

Returns:

An attribute computed based on the specified key.

addAttr

public boolean addAttr(COSARAttr attr)

Deprecated.

setFromOSAR

public void setFromOSAR(OSAR osar)
                 throws java.lang.Exception

Deprecated.

This function is used to set the COSAR based on the contents of the OSAR.

Throws:

java.lang.Exception

append

public boolean append(COSAR osar)

Deprecated.

This function is used to append another COSAR.

Returns:

true if successful, false otherwise.

getOSAR

public OSAR getOSAR()

Deprecated.

This function returns the equivalent OSAR.

removeAllAttrs

public void removeAllAttrs()

Deprecated.

This function removes all attributes from the OSAR.

newOSARAttr

public static COSARAttr newOSARAttr(java.lang.String id,
                    int type)
                             throws java.lang.Exception

Deprecated.

This function builds a new COSARAttr based on the type and returns it.

Throws:

java.lang.Exception

newOSARAttr

public static COSARAttr newOSARAttr(OSARecAttr recAttr)
                             throws java.lang.Exception

Deprecated.

This function builds a new COSARAttr based on a OSARecAttr and returns it.

Throws:

java.lang.Exception

toString

public java.lang.String toString()

Deprecated.

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

getField

public final DCField getField(java.lang.String attrId)

Deprecated.

Description copied from interface: DCFieldContainer

Retrieves field value with the specified id

Specified by:

getField in interface DCFieldContainer

Parameters:

attrId - Identifier of the desired field

Returns:

The DCField object that represents the field

getField

public DCField getField(FieldKey key)

Deprecated.

Specified by:

getField in interface DCFieldContainer

getFieldValue

public final byte[] getFieldValue(java.lang.String attrId)

Deprecated.

Description copied from interface: DCFieldContainer

Retrieves field value with the specified id

Specified by:

getFieldValue in interface DCFieldContainer

Parameters:

attrId - Identifier of the desired field

Returns:

the bytes that represent the field value

getFieldValue

public byte[] getFieldValue(FieldKey key)

Deprecated.

Specified by:

getFieldValue in interface DCFieldContainer

setField

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

Deprecated.

Description copied from interface: DCFieldContainer

Stores a given value at the specified id

Specified by:

setField in interface DCFieldContainer

Parameters:

attrId - Numeric identifier for the field

type - Data type for the field

value - Value to be stored in the given field

setField

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

Deprecated.

Description copied from interface: DCFieldContainer

Stores a given value at the specified id

Specified by:

setField in interface DCFieldContainer

Parameters:

attrId - Identifier for the field

type - Data type for the field

value - Value to be stored in the given field

setField

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

Deprecated.

Specified by:

setField in interface DCFieldContainer

setField

public final void setField(DCField field)

Deprecated.

Description copied from interface: DCFieldContainer

Stores a given value at the specified id

Specified by:

setField in interface DCFieldContainer

Parameters:

field - The DCField object representing the field.

getType

public final int getType(java.lang.String attrId)

Deprecated.

Description copied from interface: DCFieldContainer

Retrieves the type of the value stored at the specified id

Specified by:

getType in interface DCFieldContainer

Parameters:

attrId - Identifier of the field

Returns:

int value, representing the type

toByteArray

public final byte[] toByteArray()

Deprecated.

Description copied from interface: DCFieldContainer

Converts the data contained in this object to a byte array

Specified by:

toByteArray in interface DCFieldContainer

Returns:

byte[] representation of the data

clone

public java.lang.Object clone()

Deprecated.

Specified by:

clone in interface DCFieldContainer

Overrides:

clone in class java.lang.Object