com.xpn.xwiki.plugin.applicationmanager.core.doc.objects.classes
Interface SuperClass

All Known Implementing Classes:

AbstractSuperClass, XWikiApplicationClass

public interface SuperClass

Interface that give way to manage a XWiki class.

• assume that the XWiki class exist in the context we are working
• search in documents that contains this class with conditions on class fields
• support the XWiki norm about spaces and documents naming

Version:

$Id: $

Field Summary

static java.lang.String	XWIKI_CLASS_SPACE_PREFIX Default prefix for a document's space containing a class.
static java.lang.String	XWIKI_CLASS_SPACE_SUFFIX Default suffix for a document's space containing a class.
static java.lang.String	XWIKI_CLASS_SUFFIX Default suffix for the document containing the class.
static java.lang.String	XWIKI_CLASSSHEET_SPACE_SUFFIX Default suffix for a document's space containing a class sheet.
static java.lang.String	XWIKI_CLASSSHEET_SUFFIX Default suffix for a document containing a class sheet.
static java.lang.String	XWIKI_CLASSTEMPLATE_SPACE_SUFFIX Default suffix for a document's space containing a class template.
static java.lang.String	XWIKI_CLASSTEMPLATE_SUFFIX Default suffix for a document containing a class template.

Method Summary

java.lang.String	createWhereClause(java.lang.String[][] fieldDescriptors, java.util.List parameterValues) Construct HQL where clause to use with XWikiStoreInterface "searchDocuments" methods.
com.xpn.xwiki.objects.classes.BaseClass	getBaseClass()
com.xpn.xwiki.api.Document	getClassDocument(com.xpn.xwiki.XWikiContext context) Get the document containing the class in this context's database.
java.lang.String	getClassFullName()
java.lang.String	getClassName()
java.lang.String	getClassPrefix()
java.lang.String	getClassSheetDefaultContent()
com.xpn.xwiki.api.Document	getClassSheetDocument(com.xpn.xwiki.XWikiContext context) Get the document containing the class sheet for this context's database.
java.lang.String	getClassSheetFullName()
java.lang.String	getClassSheetName()
java.lang.String	getClassSheetSpace()
java.lang.String	getClassSpace()
java.lang.String	getClassSpacePrefix()
java.lang.String	getClassTemplateDefaultContent()
com.xpn.xwiki.api.Document	getClassTemplateDocument(com.xpn.xwiki.XWikiContext context) Get the document containing the class template for this context's database.
java.lang.String	getClassTemplateFullName()
java.lang.String	getClassTemplateName()
java.lang.String	getClassTemplateSpace()
java.lang.String	getItemDefaultName(java.lang.String docFullName) Get item name extracted from document full name.
java.lang.String	getItemDocumentDefaultFullName(java.lang.String itemName, com.xpn.xwiki.XWikiContext context) Get document full name from item name item.
java.lang.String	getItemDocumentDefaultName(java.lang.String itemName, com.xpn.xwiki.XWikiContext context) Get document name from item name item.
SuperDocument	getSuperDocument(java.lang.String itemName, int objectId, boolean validate, com.xpn.xwiki.XWikiContext context) Get document by full name from item name itemName.
boolean	isInstance(com.xpn.xwiki.api.Document doc) Determines if the specified doc is compatible with this xwiki class (if he contains class object).
boolean	isInstance(com.xpn.xwiki.doc.XWikiDocument doc) Determines if the specified doc is compatible with this xwiki class (if he contains class object).
SuperDocument	newSuperDocument(java.lang.String docFullName, int objId, com.xpn.xwiki.XWikiContext context) Create new super document containing object of class getClassFullName().
SuperDocument	newSuperDocument(com.xpn.xwiki.XWikiContext context) Create new super document containing object of class getClassFullName().
SuperDocument	newSuperDocument(com.xpn.xwiki.doc.XWikiDocument doc, int objId, com.xpn.xwiki.XWikiContext context) Create new super document containing object of class getClassFullName().
java.util.List	newSuperDocumentList(java.util.List documents, com.xpn.xwiki.XWikiContext context) Create new super document for each object of class getClassFullName() of each XWikiDocument in the list and return it.
java.util.List	newSuperDocumentList(com.xpn.xwiki.doc.XWikiDocument documents, com.xpn.xwiki.XWikiContext context) Create new super documents for each object of class getClassFullName() for provided XWikiDocument and return it.

Field Detail

XWIKI_CLASS_SUFFIX

static final java.lang.String XWIKI_CLASS_SUFFIX

Default suffix for the document containing the class.

See Also:

Constant Field Values

XWIKI_CLASSSHEET_SUFFIX

static final java.lang.String XWIKI_CLASSSHEET_SUFFIX

Default suffix for a document containing a class sheet.

See Also:

Constant Field Values

XWIKI_CLASSTEMPLATE_SUFFIX

static final java.lang.String XWIKI_CLASSTEMPLATE_SUFFIX

Default suffix for a document containing a class template.

See Also:

Constant Field Values

XWIKI_CLASS_SPACE_PREFIX

static final java.lang.String XWIKI_CLASS_SPACE_PREFIX

Default prefix for a document's space containing a class.

See Also:

Constant Field Values

XWIKI_CLASS_SPACE_SUFFIX

static final java.lang.String XWIKI_CLASS_SPACE_SUFFIX

Default suffix for a document's space containing a class.

See Also:

Constant Field Values

XWIKI_CLASSSHEET_SPACE_SUFFIX

static final java.lang.String XWIKI_CLASSSHEET_SPACE_SUFFIX

Default suffix for a document's space containing a class sheet.

See Also:

Constant Field Values

XWIKI_CLASSTEMPLATE_SPACE_SUFFIX

static final java.lang.String XWIKI_CLASSTEMPLATE_SPACE_SUFFIX

Default suffix for a document's space containing a class template.

See Also:

Constant Field Values

Method Detail

getClassSpacePrefix

java.lang.String getClassSpacePrefix()

Returns:

the space prefix name of the document containing the class.

getClassPrefix

java.lang.String getClassPrefix()

Returns:

the prefix name of the document containing the class. Usually extracted from : ClassSpace.ClassPrefixXWIKI_CLASS_SUFFIX.

See Also:

getClassSpace()

getClassSpace

java.lang.String getClassSpace()

Returns:

the space name of the document containing the class. Usually class space is : SpacePrefixXWIKI_CLASS_SPACE_SUFFIX.

See Also:

getClassSpacePrefix(), XWIKI_CLASS_SPACE_SUFFIX

getClassName

java.lang.String getClassName()

Returns:

the name of the document containing the class. Usually class name is : ClassPrefixXWIKI_CLASS_SUFFIX.

See Also:

getClassFullName(), getClassPrefix(), XWIKI_CLASS_SUFFIX

getClassFullName

java.lang.String getClassFullName()

Returns:

the full name of the document containing the class. Usually class full name is : ClassSpace.ClassName.

See Also:

getClassName(), getClassSpace()

getClassTemplateSpace

java.lang.String getClassTemplateSpace()

Returns:

the space name of the document containing the class template. Usually class template space name is : ClassSpacePrefixXWIKI_CLASSTEMPLATE_SPACE_SUFFIX.

See Also:

getClassPrefix(), XWIKI_CLASSTEMPLATE_SPACE_SUFFIX

getClassTemplateName

java.lang.String getClassTemplateName()

Returns:

the name of the document containing the class template. Usually class template name is : ClassPrefixClassXWIKI_CLASSTEMPLATE_SUFFIX.

See Also:

getClassPrefix(), getClassTemplateFullName(), XWIKI_CLASSTEMPLATE_SUFFIX

getClassTemplateFullName

java.lang.String getClassTemplateFullName()

Returns:

the full name of the document containing the class template. Usually class template full name is : ClassTemplateSpace.ClassTemplateName.

See Also:

getClassTemplateSpace(), getClassTemplateName()

getClassSheetSpace

java.lang.String getClassSheetSpace()

Returns:

the space name of the document containing the class sheet. Usually class sheet space name is : ClassSpacePrefixXWIKI_CLASSSHEET_SPACE_SUFFIX.

See Also:

getClassSpacePrefix(), XWIKI_CLASSSHEET_SPACE_SUFFIX

getClassSheetName

java.lang.String getClassSheetName()

Returns:

the name of the document containing the class sheet. Usually class sheet name is : ClassPrefixXWIKI_CLASSSHEET_SUFFIX.

See Also:

getClassPrefix(), getClassSheetFullName(), XWIKI_CLASSSHEET_SUFFIX

getClassSheetFullName

java.lang.String getClassSheetFullName()

Returns:

the full name of the document containing the class sheet. Usually class sheet full name is : ClassSheetSpace.ClassSheetName.

See Also:

getClassSheetSpace(), getClassSheetName()

getBaseClass

com.xpn.xwiki.objects.classes.BaseClass getBaseClass()

Returns:

the BaseClass managed by this SuperClass.

getClassDocument

com.xpn.xwiki.api.Document getClassDocument(com.xpn.xwiki.XWikiContext context)
                                            throws com.xpn.xwiki.XWikiException

Get the document containing the class in this context's database.

Parameters:

context - the XWiki context.

Returns:

the document containing the class for this context.

Throws:

com.xpn.xwiki.XWikiException - error when getting class document from the database.

getClassSheetDefaultContent

java.lang.String getClassSheetDefaultContent()

Returns:

the default content to add in a new class sheet document.

getClassSheetDocument

com.xpn.xwiki.api.Document getClassSheetDocument(com.xpn.xwiki.XWikiContext context)
                                                 throws com.xpn.xwiki.XWikiException

Get the document containing the class sheet for this context's database.

Parameters:

context - the XWiki context.

Returns:

the document containing the class sheet for this context.

Throws:

com.xpn.xwiki.XWikiException - error when getting class sheet document from the database.

getClassTemplateDefaultContent

java.lang.String getClassTemplateDefaultContent()

Returns:

the default content to add in a new class template document.

getClassTemplateDocument

com.xpn.xwiki.api.Document getClassTemplateDocument(com.xpn.xwiki.XWikiContext context)
                                                    throws com.xpn.xwiki.XWikiException

Get the document containing the class template for this context's database.

Parameters:

context - the XWiki context.

Returns:

the class template document for this context.

Throws:

com.xpn.xwiki.XWikiException - error when getting class template document from the database.

isInstance

boolean isInstance(com.xpn.xwiki.doc.XWikiDocument doc)

Determines if the specified doc is compatible with this xwiki class (if he contains class object).

Parameters:

doc - the XWikidocument to test.

Returns:

true if doc support this class, false otherwise.

isInstance

boolean isInstance(com.xpn.xwiki.api.Document doc)

Determines if the specified doc is compatible with this xwiki class (if he contains class object).

Parameters:

doc - the XWikidocument to test.

Returns:

true if doc support this class, false otherwise.

getItemDocumentDefaultName

java.lang.String getItemDocumentDefaultName(java.lang.String itemName,
                                            com.xpn.xwiki.XWikiContext context)

Get document name from item name item. Usually a Document name is DocumentTypeItemName.

Parameters:

itemName - the name of the item to find.

context - the XWiki context.

Returns:

the name of the document.

See Also:

getItemDocumentDefaultFullName(String, XWikiContext), getItemDefaultName(String)

getItemDocumentDefaultFullName

java.lang.String getItemDocumentDefaultFullName(java.lang.String itemName,
                                                com.xpn.xwiki.XWikiContext context)

Get document full name from item name item. Usually a Document full name is Space.DocumentTypeItemName.

Parameters:

itemName - the name of the item.

context - the XWiki context.

Returns:

the full name of the document.

See Also:

getItemDocumentDefaultName(String, XWikiContext), getItemDefaultName(String)

getItemDefaultName

java.lang.String getItemDefaultName(java.lang.String docFullName)

Get item name extracted from document full name. Usually a Document full name is Space.DocumentTypeItemName.

Parameters:

docFullName - the full name of the document.

Returns:

the item name extracted from document name.

See Also:

getItemDocumentDefaultFullName(String, XWikiContext)

getSuperDocument

SuperDocument getSuperDocument(java.lang.String itemName,
                               int objectId,
                               boolean validate,
                               com.xpn.xwiki.XWikiContext context)
                               throws com.xpn.xwiki.XWikiException

Get document by full name from item name itemName.

Parameters:

itemName - the full name of the item.

objectId - the id of the XWiki object included in the document to manage.

validate - indicate if it return new SuperDocument or throw exception if wiki descriptor does not exist.

context - the XWiki context.

Returns:

the document.

Throws:

com.xpn.xwiki.XWikiException - error when getting document from the database.

See Also:

getItemDefaultName(String), getItemDocumentDefaultFullName(String, XWikiContext)

createWhereClause

java.lang.String createWhereClause(java.lang.String[][] fieldDescriptors,
                                   java.util.List parameterValues)

Construct HQL where clause to use with XWikiStoreInterface "searchDocuments" methods.

Parameters:

fieldDescriptors - the list of fields name/value constraints. Format : [[fieldName1, typeField1, valueField1][fieldName2, typeField2, valueField2]].

parameterValues - the where clause values filled by the method that replace the question marks (?).

Returns:

a HQL where clause.

newSuperDocument

SuperDocument newSuperDocument(com.xpn.xwiki.doc.XWikiDocument doc,
                               int objId,
                               com.xpn.xwiki.XWikiContext context)
                               throws com.xpn.xwiki.XWikiException

Create new super document containing object of class getClassFullName(). If document already exist it is returned with new object if it does not contains any.

Parameters:

doc - the XWiki document to manage.

objId - the id of the XWiki object included in the document to manage.

context - the XWiki context.

Returns:

a new SuperDocument instance.

Throws:

com.xpn.xwiki.XWikiException - error when calling SuperDocument implementation constructor.

newSuperDocument

SuperDocument newSuperDocument(com.xpn.xwiki.XWikiContext context)
                               throws com.xpn.xwiki.XWikiException

Create new super document containing object of class getClassFullName(). If document already exist it is returned with new object if it does not contains any.

Parameters:

context - the XWiki context.

Returns:

a new SuperDocument instance.

Throws:

com.xpn.xwiki.XWikiException - error when calling SuperDocument implementation constructor.

newSuperDocument

SuperDocument newSuperDocument(java.lang.String docFullName,
                               int objId,
                               com.xpn.xwiki.XWikiContext context)
                               throws com.xpn.xwiki.XWikiException

Create new super document containing object of class getClassFullName(). If document already exist it is returned with new object if it does not contains any.

Parameters:

docFullName - the full name of document to manage.

objId - the id of the XWiki object included in the document to manage.

context - the XWiki context.

Returns:

a new SuperDocument instance.

Throws:

com.xpn.xwiki.XWikiException - error when calling SuperDocument implementation constructor.

See Also:

getClassFullName()

newSuperDocumentList

java.util.List newSuperDocumentList(com.xpn.xwiki.doc.XWikiDocument documents,
                                    com.xpn.xwiki.XWikiContext context)
                                    throws com.xpn.xwiki.XWikiException

Create new super documents for each object of class getClassFullName() for provided XWikiDocument and return it.

Parameters:

documents - the list of XWikiDocument.

context - the XWiki context.

Returns:

the list of SuperDocument.

Throws:

com.xpn.xwiki.XWikiException - error when calling SuperDocument implementation constructor.

newSuperDocumentList

java.util.List newSuperDocumentList(java.util.List documents,
                                    com.xpn.xwiki.XWikiContext context)
                                    throws com.xpn.xwiki.XWikiException

Create new super document for each object of class getClassFullName() of each XWikiDocument in the list and return it.

Parameters:

documents - the list of XWikiDocument.

context - the XWiki context.

Returns:

the list of SuperDocument.

Throws:

com.xpn.xwiki.XWikiException - error when calling SuperDocument implementation constructor.