Package net.anotheria.anodoc.data

Class Property

java.lang.Object

net.anotheria.anodoc.data.DataHolder

net.anotheria.anodoc.data.Property

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IBasicStoreableObject, IPlainDataObject

Direct Known Subclasses:

BooleanProperty, DoubleProperty, FloatProperty, IntProperty, ListProperty, LongProperty, StringProperty

public abstract class Property
extends DataHolder
implements IPlainDataObject, java.lang.Cloneable

This class represents a single data entry which can be stored. It is of a plain kind (can't contain any subproperties, except the ListProperty).

Since:

1.0

Version:

$Id: $Id

Author:

lro

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Property(java.lang.String name)	Creates new Property without a value (null).
protected	Property(java.lang.String name, java.lang.Object aValue)	Creates a new Property with a given name and given value.

Method Summary

Modifier and Type	Method	Description
java.lang.Object	clone()	clone.
Property	cloneAs(java.lang.String newName)	Creates a copy of this property with a new name.
protected abstract java.lang.Object	cloneValue()	cloneValue.
boolean	equals(java.lang.Object o)
protected java.lang.String	getName()	getName.
abstract PropertyType	getPropertyType()	getPropertyType.
java.lang.String	getStorageId()	Since the can't be two equally named properties in a Document, the storageId of a Property is its name.
java.lang.Object	getValue()	Getter for the field value.
void	setValue(java.lang.Object o)	Sets the value of this Property.
java.lang.String	toString()
net.anotheria.util.xml.XMLNode	toXMLNode()	Creates an xml node for export.

Methods inherited from class net.anotheria.anodoc.data.DataHolder

getId, getSizeInBytes, hashCode, setId

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Property

protected Property(java.lang.String name)

Creates new Property without a value (null).

Parameters:

name - a String object.

Property

protected Property(java.lang.String name,
                   java.lang.Object aValue)

Creates a new Property with a given name and given value.

Parameters:

name - a String object.

aValue - a Object object.

Method Detail

getValue

public java.lang.Object getValue()

Getter for the field value.

Returns:

the value of this property.

setValue

public void setValue(java.lang.Object o)

Sets the value of this Property.

Parameters:

o - object to set

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getStorageId

public java.lang.String getStorageId()

Since the can't be two equally named properties in a Document, the storageId of a Property is its name.

Specified by:

getStorageId in interface IBasicStoreableObject

Returns:

a String object.

See Also:

IBasicStoreableObject.getStorageId()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

getName

protected java.lang.String getName()

getName.

Returns:

the name of the property

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

clone.

Overrides:

clone in class DataHolder

Returns:

a Object object.

Throws:

java.lang.CloneNotSupportedException - if any.

cloneAs

public Property cloneAs(java.lang.String newName)
                 throws java.lang.CloneNotSupportedException

Creates a copy of this property with a new name.

Parameters:

newName - a String object.

Returns:

created property with new name

Throws:

java.lang.CloneNotSupportedException - if any.

cloneValue

protected abstract java.lang.Object cloneValue()
                                        throws java.lang.CloneNotSupportedException

cloneValue.

Returns:

a Object object.

Throws:

java.lang.CloneNotSupportedException - if any.

toXMLNode

public net.anotheria.util.xml.XMLNode toXMLNode()

Creates an xml node for export.

Overrides:

toXMLNode in class DataHolder

Returns:

new XMLNode object

getPropertyType

public abstract PropertyType getPropertyType()

getPropertyType.

Returns:

a PropertyType object.