org.xwiki.model.reference
Class ObjectPropertyReference

java.lang.Object
  org.xwiki.model.reference.EntityReference
      org.xwiki.model.reference.ObjectPropertyReference

All Implemented Interfaces:

Serializable, Cloneable, Comparable<EntityReference>

public class ObjectPropertyReference
extends EntityReference

References a property in an object in a document (the value of the property).

Since:

2.3M1

Version:

$Id$

See Also:

Serialized Form

Constructor Summary

ObjectPropertyReference(EntityReference reference)
Constructor which would raise exceptions if the source entity reference does not have the appropriate type or parent, etc.

ObjectPropertyReference(String propertyName, ObjectReference objectReference)
Builds a property reference for the passed property in the passed object.

ObjectPropertyReference(String wiki, String space, String page, String objectName, String propertyName)

Method Summary

void	setParent(EntityReference parent) Overridden to ensure that the parent of a property is always an object.
void	setType(EntityType type) Overridden to check the type to be a property type.

Methods inherited from class org.xwiki.model.reference.EntityReference

clone, compareTo, equals, extractReference, getChild, getName, getParent, getRoot, getType, hashCode, setChild, setName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectPropertyReference

public ObjectPropertyReference(EntityReference reference)

Constructor which would raise exceptions if the source entity reference does not have the appropriate type or parent, etc.

Parameters:

reference - the raw reference to build this object reference from

ObjectPropertyReference

public ObjectPropertyReference(String propertyName,
                               ObjectReference objectReference)

Builds a property reference for the passed property in the passed object.

Parameters:

propertyName - the name of the property to create reference for

objectReference - the reference to the object whose property is

ObjectPropertyReference

public ObjectPropertyReference(String wiki,
                               String space,
                               String page,
                               String objectName,
                               String propertyName)

Parameters:

wiki - the wiki of the document where the parent object of this property is

space - the space of the document where the parent object of this property is

page - the document where the parent object of this property is

objectName - the name of the parent object of this property

propertyName - the name of the property to refer to

Method Detail

setType

public void setType(EntityType type)

Overridden to check the type to be a property type.

Overrides:

setType in class EntityReference

See Also:

EntityReference.setType(org.xwiki.model.EntityType)

setParent

public void setParent(EntityReference parent)

Overridden to ensure that the parent of a property is always an object.

Overrides:

setParent in class EntityReference

See Also:

EntityReference.setParent(org.xwiki.model.reference.EntityReference)