ptdb.common.dto

Class XMLDBAttribute

java.lang.Object

ptdb.common.dto.XMLDBAttribute

public class XMLDBAttribute
extends java.lang.Object

The attribute that need to be stored or retrieved from the database.

It is used as a data transfer object.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Yousef Alsaeed

Pt.AcceptedRating:

Red (yalsaeed)

Pt.ProposedRating:

Red (yalsaeed)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTE_TYPE_BOOLEAN Boolean Type.
static java.lang.String	ATTRIBUTE_TYPE_LIST List Type.
static java.lang.String	ATTRIBUTE_TYPE_STRING String Type.

Constructor Summary

Constructors

Constructor and Description
XMLDBAttribute(java.lang.String attributeName, java.lang.String attributeType) Construct an XMLDBAttribute instance with the given attribute name and type.
XMLDBAttribute(java.lang.String attributeName, java.lang.String attributeType, java.lang.String attributeId) Construct a XMLDBAttribute instance with the given attribute name.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttributeId() Return the attribute id.
java.lang.String	getAttributeName() Return the attribute name.
java.lang.String	getAttributeType() Return the attribute type.
java.util.List<java.lang.String>	getAttributeValues() Return the attribute value.
java.util.List<java.lang.String>	getAttributeValuesPlain() Get the attribute list values without checking the attribute's type.
java.lang.String	getAttributeXMLStringFormat() Create an XML string representation of XMLDBAttribute object.
void	setAttributeId(java.lang.String attributeId) Set the attribute Id.
void	setAttributeName(java.lang.String attributName) Set the name of the attribute.
void	setAttributeType(java.lang.String attributeType) Set the type of this attribute.
void	setAttributeValue(java.util.List<java.lang.String> attributeValues) Set the attribute list value only when the attribute type is list.
void	setAttributeValuesPlain(java.util.List<java.lang.String> attributeValues) Set the list values to the attribute regardless of the attribute type.
java.lang.String	toString() Get the String representation of this object information.

Methods inherited from class java.lang.Object

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

Field Detail

ATTRIBUTE_TYPE_STRING

public static final java.lang.String ATTRIBUTE_TYPE_STRING

String Type.

See Also:

Constant Field Values

ATTRIBUTE_TYPE_BOOLEAN

public static final java.lang.String ATTRIBUTE_TYPE_BOOLEAN

Boolean Type.

See Also:

Constant Field Values

ATTRIBUTE_TYPE_LIST

public static final java.lang.String ATTRIBUTE_TYPE_LIST

List Type.

See Also:

Constant Field Values

Constructor Detail

XMLDBAttribute

public XMLDBAttribute(java.lang.String attributeName,
                      java.lang.String attributeType)

Construct an XMLDBAttribute instance with the given attribute name and type.

Parameters:

attributeName - The name of the attribute to create.

attributeType - The type of the attribute to create.

XMLDBAttribute

public XMLDBAttribute(java.lang.String attributeName,
                      java.lang.String attributeType,
                      java.lang.String attributeId)

Construct a XMLDBAttribute instance with the given attribute name.

Parameters:

attributeName - The name for the given attribute.

attributeType - The type for the given attribute.

attributeId - The it for the given attribute.

Method Detail

getAttributeId

public java.lang.String getAttributeId()

Return the attribute id.

Returns:

The attribute id.

See Also:

setAttributeId(java.lang.String)

getAttributeName

public java.lang.String getAttributeName()

Return the attribute name.

Returns:

The attribute name.

See Also:

setAttributeName(java.lang.String)

getAttributeType

public java.lang.String getAttributeType()

Return the attribute type.

Returns:

A string representation of the attribute type.

See Also:

setAttributeType(java.lang.String)

getAttributeValues

public java.util.List<java.lang.String> getAttributeValues()

Return the attribute value.

Returns:

A string representation of the attribute value.

See Also:

setAttributeValue(java.util.List<java.lang.String>)

getAttributeValuesPlain

public java.util.List<java.lang.String> getAttributeValuesPlain()

Get the attribute list values without checking the attribute's type.

Returns:

The list of items for the attribute list type.

See Also:

setAttributeValuesPlain(java.util.List<java.lang.String>)

setAttributeId

public void setAttributeId(java.lang.String attributeId)

Set the attribute Id.

Parameters:

attributeId - the attribute id to be set.

See Also:

getAttributeId()

setAttributeName

public void setAttributeName(java.lang.String attributName)

Set the name of the attribute.

Parameters:

attributName - The name of the attribute.

See Also:

getAttributeName()

setAttributeType

public void setAttributeType(java.lang.String attributeType)

Set the type of this attribute.

Parameters:

attributeType - The type to set to this attribute.

See Also:

getAttributeType()

setAttributeValue

public void setAttributeValue(java.util.List<java.lang.String> attributeValues)

Set the attribute list value only when the attribute type is list.

Parameters:

attributeValues - The list of attribute values.

See Also:

getAttributeValues()

setAttributeValuesPlain

public void setAttributeValuesPlain(java.util.List<java.lang.String> attributeValues)

Set the list values to the attribute regardless of the attribute type.

Parameters:

attributeValues - The list values to be set to this attribute.

See Also:

getAttributeValuesPlain()

toString

public java.lang.String toString()

Get the String representation of this object information.

Overrides:

toString in class java.lang.Object

Returns:

String representation of the attribute information.

getAttributeXMLStringFormat

public java.lang.String getAttributeXMLStringFormat()

Create an XML string representation of XMLDBAttribute object.

Returns:

The XML string representation of XMLDBAttribute object.