|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.xwiki.model.reference.EntityReference org.xwiki.model.reference.ObjectPropertyReference
public class ObjectPropertyReference
References a property in an object in a document (the value of the property).
Field Summary |
---|
Fields inherited from class org.xwiki.model.reference.EntityReference |
---|
TOSTRING_SERIALIZER |
Constructor Summary | |
---|---|
|
ObjectPropertyReference(EntityReference reference)
Constructor which would raise exceptions if the source entity reference does not have the appropriate type or parent, etc. |
protected |
ObjectPropertyReference(EntityReference reference,
EntityReference oldReference,
EntityReference newReference)
Clone an ObjectPropertyReference, but replace one of the parent in the chain by a new one. |
|
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)
Deprecated. |
Method Summary | |
---|---|
ObjectPropertyReference |
replaceParent(EntityReference oldParent,
EntityReference newParent)
Return a clone of this reference, but with one of its parent replaced by another one. |
protected void |
setParent(EntityReference parent)
Entity reference are immutable since 3.3M2, so this method is now protected. |
protected void |
setType(EntityType type)
Entity reference are immutable since 3.3M2, so this method is now protected. |
Methods inherited from class org.xwiki.model.reference.EntityReference |
---|
appendParent, compareTo, equals, extractReference, getName, getParameter, getParent, getReversedReferenceChain, getRoot, getType, hashCode, removeParent, setName, setParameter, setParameters, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ObjectPropertyReference(EntityReference reference)
reference
- the raw reference to build this object reference fromprotected ObjectPropertyReference(EntityReference reference, EntityReference oldReference, EntityReference newReference)
reference
- the reference that is clonedoldReference
- the old parent that will be replacednewReference
- the new parent that will replace oldReference in the chainpublic ObjectPropertyReference(String propertyName, ObjectReference objectReference)
propertyName
- the name of the property to create reference forobjectReference
- the reference to the object whose property is@Deprecated public ObjectPropertyReference(String wiki, String space, String page, String objectName, String propertyName)
wiki
- the wiki of the document where the parent object of this property isspace
- the space of the document where the parent object of this property ispage
- the document where the parent object of this property isobjectName
- the name of the parent object of this propertypropertyName
- the name of the property to refer toMethod Detail |
---|
protected void setType(EntityType type)
setType
in class EntityReference
type
- the type for this entityEntityReference.setType(org.xwiki.model.EntityType)
protected void setParent(EntityReference parent)
setParent
in class EntityReference
parent
- the parent for this entity, may be null for a root entity.EntityReference.setParent(org.xwiki.model.reference.EntityReference)
public ObjectPropertyReference replaceParent(EntityReference oldParent, EntityReference newParent)
EntityReference
replaceParent
in class EntityReference
oldParent
- the old parent that will be replacednewParent
- the new parent that will replace oldParent in the chain. If the same as oldParent,
this is returned.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |