com.nt.udc.io

Class COSARAttr

java.lang.Object

com.nt.udc.io.COSARAttr

Direct Known Subclasses:

COSARAttrByte, COSARAttrDouble, COSARAttrFloat, COSARAttrInt, COSARAttrIP, COSARAttrLong, COSARAttrShort, COSARAttrString, COSARAttrUInt

public abstract class COSARAttr
extends java.lang.Object

This class represents the abstract base-class for all OSAR attributes ( fields ).

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	m_id OSAR attr id
protected int	m_type OSAR attr type

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	COSARAttr(int type, java.lang.String id) This constructor initializes a new COSARAttr based on type and id.

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getBytesValue()
DCField	getDCField()
double	getDoubleValue()
java.lang.String	getId()
byte[]	getIPValue()
long	getLongValue()
long	getMillisValue()
OSARecAttr	getRecAttr()
java.lang.String	getStringValue()
int	getType()
protected int	idToInt()
void	setId(java.lang.String id)
boolean	setStringValue(java.lang.String value) This function sets the attribute value based on a string.
boolean	setValue(COSARAttr attr) This function sets converts the value contained by the passed attribute to the current type
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

m_type

protected int m_type

OSAR attr type

m_id

protected java.lang.String m_id

OSAR attr id

Constructor Detail

COSARAttr

protected COSARAttr(int type,
         java.lang.String id)

This constructor initializes a new COSARAttr based on type and id. Instances may be created only by sub-classes.

Parameters:

type - The type of the OSAR attribute

id - The id of the OSAR attribute

Method Detail

getType

public int getType()

Returns:

The type of the OSAR attribute

getId

public final java.lang.String getId()

Returns:

The field-id of the OSAR attribute

getStringValue

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

Returns:

The value as a string

Throws:

java.lang.Exception

getLongValue

public long getLongValue()
                  throws java.lang.Exception

Returns:

The value as a long

Throws:

java.lang.Exception

getMillisValue

public long getMillisValue()
                    throws java.lang.Exception

Returns:

The value as in milliseconds

Throws:

java.lang.Exception

getIPValue

public byte[] getIPValue()
                  throws java.lang.Exception

Returns:

The value as a raw IP address

Throws:

java.lang.Exception

getBytesValue

public byte[] getBytesValue()
                     throws java.lang.Exception

Returns:

The value as an array of bytes

Throws:

java.lang.Exception

getDoubleValue

public double getDoubleValue()
                      throws java.lang.Exception

Returns:

The value as a double

Throws:

java.lang.Exception

getRecAttr

public OSARecAttr getRecAttr()

Returns:

The equivalent OSARecAttr

getDCField

public DCField getDCField()

Returns:

The equivalent DCField

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the OSAR attribute

setId

public final void setId(java.lang.String id)

setStringValue

public boolean setStringValue(java.lang.String value)

This function sets the attribute value based on a string.

Returns:

true if successful, false otherwise

setValue

public boolean setValue(COSARAttr attr)

This function sets converts the value contained by the passed attribute to the current type

idToInt

protected int idToInt()