Package | Description |
---|---|
org.xwiki.model | |
org.xwiki.model.reference | |
org.xwiki.model.script |
Modifier and Type | Method and Description |
---|---|
EntityReference |
ModelContext.getCurrentEntityReference() |
Modifier and Type | Method and Description |
---|---|
void |
ModelContext.setCurrentEntityReference(EntityReference entityReference) |
Modifier and Type | Class and Description |
---|---|
class |
AttachmentReference
Represents a reference to an Attachment (document reference and file name).
|
class |
BlockReference
Reference to a block, a structured part of the content of a document or an object property.
|
class |
ClassPropertyReference
References a property in a class in a document (the description of the property).
|
class |
DocumentReference
Represents a reference to a document (wiki, space and page names).
|
class |
LocalDocumentReference
Represents a reference to a document in the current wiki.
|
class |
ObjectPropertyReference
References a property in an object in a document (the value of the property).
|
class |
ObjectReference
Reference to an object in a document (by classname and index, document, space, wiki).
|
class |
PartialEntityReference
An
EntityReference used to match another one. |
class |
RegexEntityReference
An
EntityReference used to match another one. |
class |
SpaceReference
Represents a reference to a space (space name).
|
class |
WikiReference
Represents a reference to a wiki (wiki name).
|
Modifier and Type | Method and Description |
---|---|
EntityReference |
EntityReference.appendParent(EntityReference newParent)
Return a clone of this reference with a parent appended at the root of its parents chain.
|
EntityReference |
EntityReference.extractReference(EntityType type)
Extract the entity of the given type from this one.
|
EntityReference |
EntityReference.getParent() |
EntityReference |
EntityReferenceTreeNode.getReference() |
EntityReference |
EntityReference.getRoot() |
EntityReference |
EntityReference.removeParent(EntityReference oldParent)
Return a clone of this reference truncated to a null parent when it reach the given parent.
|
EntityReference |
EntityReference.replaceParent(EntityReference oldParent,
EntityReference newParent)
Return a clone of this reference, but with one of its parent replaced by another one.
|
EntityReference |
EntityReferenceResolver.resolve(T entityReferenceRepresentation,
EntityType type,
Object... parameters) |
Modifier and Type | Method and Description |
---|---|
Collection<EntityReference> |
EntityReferenceTreeNode.getLocales() |
List<EntityReference> |
EntityReference.getReversedReferenceChain() |
Modifier and Type | Method and Description |
---|---|
EntityReference |
EntityReference.appendParent(EntityReference newParent)
Return a clone of this reference with a parent appended at the root of its parents chain.
|
int |
EntityReference.compareTo(EntityReference reference) |
EntityReferenceSet |
EntityReferenceSet.excludes(EntityReference reference) |
EntityReferenceSet |
EntityReferenceSet.includes(EntityReference reference) |
boolean |
EntityReferenceSet.matches(EntityReference reference) |
EntityReference |
EntityReference.removeParent(EntityReference oldParent)
Return a clone of this reference truncated to a null parent when it reach the given parent.
|
BlockReference |
BlockReference.replaceParent(EntityReference oldParent,
EntityReference newParent) |
ObjectReference |
ObjectReference.replaceParent(EntityReference oldParent,
EntityReference newParent) |
SpaceReference |
SpaceReference.replaceParent(EntityReference oldParent,
EntityReference newParent) |
ObjectPropertyReference |
ObjectPropertyReference.replaceParent(EntityReference oldParent,
EntityReference newParent) |
AttachmentReference |
AttachmentReference.replaceParent(EntityReference oldParent,
EntityReference newParent) |
EntityReference |
EntityReference.replaceParent(EntityReference oldParent,
EntityReference newParent)
Return a clone of this reference, but with one of its parent replaced by another one.
|
DocumentReference |
DocumentReference.replaceParent(EntityReference oldParent,
EntityReference newParent) |
ClassPropertyReference |
ClassPropertyReference.replaceParent(EntityReference oldParent,
EntityReference newParent) |
T |
EntityReferenceSerializer.serialize(EntityReference reference,
Object... parameters)
Serialize an entity reference into a new representation of type
|
protected void |
BlockReference.setParent(EntityReference parent)
Entity reference are immutable since 3.3M2, so this method is now protected.
|
protected void |
ObjectReference.setParent(EntityReference parent)
Entity reference are immutable since 3.3M2, so this method is now protected.
|
protected void |
SpaceReference.setParent(EntityReference parent)
Entity reference are immutable since 3.3M2, so this method is now protected.
|
protected void |
ObjectPropertyReference.setParent(EntityReference parent)
Entity reference are immutable since 3.3M2, so this method is now protected.
|
protected void |
AttachmentReference.setParent(EntityReference parent)
Entity reference are immutable since 3.3M2, so this method is now protected.
|
protected void |
EntityReference.setParent(EntityReference parent)
Entity reference are immutable since 3.3M2, so this method is now protected.
|
protected void |
DocumentReference.setParent(EntityReference parent)
Entity reference are immutable since 3.3M2, so this method is now protected.
|
protected void |
ClassPropertyReference.setParent(EntityReference parent)
Entity reference are immutable since 3.3M2, so this method is now protected.
|
protected void |
WikiReference.setParent(EntityReference parent)
Entity reference are immutable since 3.3M2, so this method is now protected.
|
Constructor and Description |
---|
AttachmentReference(EntityReference reference)
Special constructor that transforms a generic entity reference into an
AttachmentReference . |
AttachmentReference(EntityReference reference,
EntityReference oldReference,
EntityReference newReference)
Clone an AttachmentReference, but replace one of the parent in the chain by a new one.
|
BlockReference(EntityReference reference)
Constructor which would raise exceptions if the source entity reference does not have the appropriate type or
parent, etc.
|
BlockReference(EntityReference reference,
EntityReference oldReference,
EntityReference newReference)
Clone an BlockReference, but replace one of the parent in the chain by a new one.
|
ClassPropertyReference(EntityReference reference)
Constructor which would raise exceptions if the source entity reference does not have the appropriate type or
parent, etc.
|
ClassPropertyReference(EntityReference reference,
EntityReference oldReference,
EntityReference newReference)
Clone an ClassPropertyReference, but replace one of the parent in the chain by a new one.
|
DocumentReference(EntityReference reference)
Special constructor that transforms a generic entity reference into a
DocumentReference . |
DocumentReference(EntityReference reference,
EntityReference oldReference,
EntityReference newReference)
Clone an DocumentReference, but replace one of the parent in the chain by a new one.
|
DocumentReference(EntityReference reference,
Locale locale)
Clone the provided reference and change the Locale.
|
EntityReference(EntityReference reference)
Clone an EntityReference.
|
EntityReference(EntityReference reference,
EntityReference parent)
Clone an EntityReference, but use the specified parent for its new parent.
|
EntityReference(EntityReference reference,
EntityReference oldReference,
EntityReference newReference)
Clone an EntityReference, but replace one of the parent in the chain by an other one.
|
EntityReference(String name,
EntityType type,
EntityReference parent)
Create a new EntityReference.
|
EntityReference(String name,
EntityType type,
EntityReference parent,
Map<String,Serializable> parameters)
Create a new EntityReference.
|
EntityReferenceTree(Comparator<String> comparator,
EntityReference... references) |
EntityReferenceTree(EntityReference... references) |
LocalDocumentReference(EntityReference reference) |
LocalDocumentReference(EntityReference entityReference,
Locale locale) |
ObjectPropertyReference(EntityReference reference)
Constructor which would raise exceptions if the source entity reference does not have the appropriate type or
parent, etc.
|
ObjectPropertyReference(EntityReference reference,
EntityReference oldReference,
EntityReference newReference)
Clone an ObjectPropertyReference, but replace one of the parent in the chain by a new one.
|
ObjectReference(EntityReference reference)
Constructor which would raise exceptions if the source entity reference does not have the appropriate type or
parent, etc.
|
ObjectReference(EntityReference reference,
EntityReference oldReference,
EntityReference newReference)
Clone an ObjectReference, but replace one of the parent in the chain by a new one.
|
PartialEntityReference(String name,
EntityType type,
EntityReference parent)
Create a new EntityReference.
|
RegexEntityReference(Pattern pattern,
EntityType type,
EntityReference parent) |
SpaceReference(EntityReference reference)
Special constructor that transforms a generic entity reference into a
SpaceReference . |
SpaceReference(EntityReference reference,
EntityReference oldReference,
EntityReference newReference)
Clone an SpaceReference, but replace one of the parent in the chain by a new one.
|
SpaceReference(String spaceName,
EntityReference parent)
Create a space reference based on a space name and a parent entity reference.
|
WikiReference(EntityReference reference)
Special constructor that transforms a generic entity reference into a
WikiReference . |
Constructor and Description |
---|
EntityReferenceTree(Comparator<String> comparator,
Iterable<? extends EntityReference> references) |
EntityReferenceTree(Iterable<? extends EntityReference> references) |
Modifier and Type | Method and Description |
---|---|
EntityReference |
ModelScriptService.createEntityReference(String name,
EntityType type)
Creates any
EntityReference from a string. |
EntityReference |
ModelScriptService.createEntityReference(String name,
EntityType type,
EntityReference parent)
Creates any
EntityReference from a string. |
Modifier and Type | Method and Description |
---|---|
EntityReference |
ModelScriptService.createEntityReference(String name,
EntityType type,
EntityReference parent)
Creates any
EntityReference from a string. |
String |
ModelScriptService.serialize(EntityReference reference,
Object... parameters) |
String |
ModelScriptService.serialize(EntityReference reference,
String hint,
Object... parameters) |
EntityReferenceTree |
ModelScriptService.toTree(EntityReference... references)
Convert passed references to a tree of references.
|
Modifier and Type | Method and Description |
---|---|
EntityReferenceTree |
ModelScriptService.toTree(Iterable<? extends EntityReference> references)
Convert passed references to a tree of references.
|
Copyright © 2004–2015 XWiki. All rights reserved.