org.apache.jackrabbit.commons

Class AbstractProperty

java.lang.Object

org.apache.jackrabbit.commons.AbstractItem

org.apache.jackrabbit.commons.AbstractProperty

public abstract class AbstractProperty
extends AbstractItem

Abstract base class for implementing the JCR Property interface.

Item methods without a default implementation:

• Item#getName()
• Item#getParent()
• Item#getSession()
• Item#isModified()
• Item#isNew()
• Item#isSame(Item)
• Item#refresh(boolean)
• Item#save()

Property methods without a default implementation:

• Property#getDefinition()
• Property#getValue()
• Property#getValues()

NOTE: Many of the default method implementations in this base class rely on the parent node being accessible through the Item#getParent() call. It is possible (though unlikely) that access controls deny access to a containing node even though a property is accessible. In such cases the default method implementations in this class will not work.

Constructor Summary

Constructors

Constructor and Description
AbstractProperty()

Method Summary

Modifier and Type	Method and Description
void	accept(ItemVisitor visitor) Accepts the given item visitor.
boolean	getBoolean() Returns the boolean value of this property.
java.util.Calendar	getDate() Returns the date value of this property.
double	getDouble() Returns the double value of this property.
long	getLength() Returns the length of the value of this property.
long[]	getLengths() Returns the lengths of the values of this property.
long	getLong() Returns the long value of this property.
Node	getNode() If this property is of type REFERENCE, WEAKREFERENCE or PATH (or convertible to one of these types) this method returns the Node to which this property refers.
java.lang.String	getPath() Returns the path of this property.
Property	getProperty() If this property is of type PATH (or convertible to this type) this method returns the Property to which this property refers.
java.io.InputStream	getStream() Returns the binary value of this property.
java.lang.String	getString() Returns the string value of this property.
int	getType() Returns the type of this property.
boolean	isNode() Returns false.
void	remove() Removes this property.
void	setValue(Node value) Sets the value of this property.
void	setValue(Value value) Sets the value of this property.
void	setValue(Value[] values) Sets the values of this property.

Methods inherited from class org.apache.jackrabbit.commons.AbstractItem

getAncestor, getDepth, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractProperty

public AbstractProperty()

Method Detail

accept

public void accept(ItemVisitor visitor)
            throws RepositoryException

Accepts the given item visitor.

The default implementation calls ItemVisitor#visit(Property) on the given visitor with this property as the argument.

Parameters:

visitor - item visitor

Throws:

RepositoryException - if an error occurs

getPath

public java.lang.String getPath()
                         throws RepositoryException

Returns the path of this property.

The default implementation constructs the path from the path of the parent node and the name of this property.

Returns:

property path

Throws:

RepositoryException - if an error occurs

isNode

public boolean isNode()

Returns false.

Returns:

false

remove

public void remove()
            throws RepositoryException

Removes this property.

The default implementation calls Node#setProperty(String, Value) with a null value on the parent node.

Throws:

RepositoryException - if an error occurs

getBoolean

public boolean getBoolean()
                   throws RepositoryException

Returns the boolean value of this property.

The default implementation forwards the method call to the Value instance returned by the generic Property#getValue() method.

Returns:

boolean value

Throws:

RepositoryException - if an error occurs

getDate

public java.util.Calendar getDate()
                           throws RepositoryException

Returns the date value of this property.

The default implementation forwards the method call to the Value instance returned by the generic Property#getValue() method.

Returns:

date value

Throws:

RepositoryException - if an error occurs

getDouble

public double getDouble()
                 throws RepositoryException

Returns the double value of this property.

The default implementation forwards the method call to the Value instance returned by the generic Property#getValue() method.

Returns:

double value

Throws:

RepositoryException - if an error occurs

getLength

public long getLength()
               throws RepositoryException

Returns the length of the value of this property.

The default implementation measures the length of the Value instance returned by the generic Property#getValue() method.

Returns:

length of the property value

Throws:

RepositoryException - if an error occurs

getLengths

public long[] getLengths()
                  throws RepositoryException

Returns the lengths of the values of this property.

The default implementation measures the lengths of the Value instances returned by the generic Property#getValues() method.

Returns:

lengths of the property values

Throws:

RepositoryException - if an error occurs

getLong

public long getLong()
             throws RepositoryException

Returns the long value of this property.

The default implementation forwards the method call to the Value instance returned by the generic Property#getValue() method.

Returns:

long value

Throws:

RepositoryException - if an error occurs

getNode

public Node getNode()
             throws ValueFormatException,
                    RepositoryException

If this property is of type REFERENCE, WEAKREFERENCE or PATH (or convertible to one of these types) this method returns the Node to which this property refers.

If this property is of type PATH and it contains a relative path, it is interpreted relative to the parent node of this property. For example "." refers to the parent node itself, ".." to the parent of the parent node and "foo" to a sibling node of this property.

Returns:

the referenced Node

Throws:

ValueFormatException - if this property cannot be converted to a referring type (REFERENCE, WEAKREFERENCE or PATH), if the property is multi-valued or if this property is a referring type but is currently part of the frozen state of a version in version storage.

ItemNotFoundException - If this property is of type PATH or WEAKREFERENCE and no target node accessible by the current Session exists in this workspace. Note that this applies even if the property is a PATHS and a property exists at the specified location. To dereference to a target property (as opposed to a target node), the method Property.getProperty is used.

RepositoryException - if another error occurs.

getProperty

public Property getProperty()
                     throws RepositoryException

If this property is of type PATH (or convertible to this type) this method returns the Property to which this property refers.

If this property contains a relative path, it is interpreted relative to the parent node of this property. Therefore, when resolving such a relative path, the segment "." refers to the parent node itself, ".." to the parent of the parent node and "foo" to a sibling property of this property or this property itself.

For example, if this property is located at /a/b/c and it has a value of "../d" then this method will return the property at /a/d if such exists.

If this property is multi-valued, this method throws a ValueFormatException.

If this property cannot be converted to a PATH then a ValueFormatException is thrown.

If this property is currently part of the frozen state of a version in version storage, this method will throw a ValueFormatException.

Returns:

the referenced property

Throws:

ValueFormatException - if this property cannot be converted to a PATH, if the property is multi-valued or if this property is a referring type but is currently part of the frozen state of a version in version storage.

ItemNotFoundException - If no property accessible by the current Session exists in this workspace at the specified path. Note that this applies even if a node exists at the specified location. To dereference to a target node, the method Property.getNode is used.

RepositoryException - if another error occurs.

getStream

public java.io.InputStream getStream()
                              throws RepositoryException

Returns the binary value of this property.

The default implementation forwards the method call to the Value instance returned by the generic Property#getValue() method.

Returns:

binary value

Throws:

RepositoryException - if an error occurs

getString

public java.lang.String getString()
                           throws RepositoryException

Returns the string value of this property.

The default implementation forwards the method call to the Value instance returned by the generic Property#getValue() method.

Returns:

string value

Throws:

RepositoryException - if an error occurs

getType

public int getType()
            throws RepositoryException

Returns the type of this property.

The default implementation forwards the method call to the Value instance returned by the generic Property#getValue() method.

Returns:

property type

Throws:

RepositoryException - if an error occurs

setValue

public void setValue(Value value)
              throws RepositoryException

Sets the value of this property.

The default implementation forwards the call to the Node#setProperty(String, Value) method of the parent node using the name of this property.

Parameters:

value - passed through

Throws:

RepositoryException - if an error occurs

setValue

public void setValue(Value[] values)
              throws RepositoryException

Sets the values of this property.

The default implementation forwards the call to the Node#setProperty(String, Value[]) method of the parent node using the name of this property.

Parameters:

values - passed through

Throws:

RepositoryException - if an error occurs

setValue

public void setValue(Node value)
              throws RepositoryException

Sets the value of this property.

The default implementation forwards the call to the Node#setProperty(String, Node) method of the parent node using the name of this property.

Parameters:

value - passed through

Throws:

RepositoryException - if an error occurs