com.xpn.xwiki.plugin.applicationmanager.core.doc.objects.classes
Class AbstractXClassManager<T extends XObjectDocument>

java.lang.Object
  com.xpn.xwiki.plugin.applicationmanager.core.doc.objects.classes.AbstractXClassManager<T>

Type Parameters:

T - the item class extending XObjectDocument.

All Implemented Interfaces:

XClassManager<T>

Direct Known Subclasses:

XWikiApplicationClass

public abstract class AbstractXClassManager<T extends XObjectDocument>
extends java.lang.Object
implements XClassManager<T>

Abstract implementation of XClassManager.

This class has to be extended with at least :

• overload updateBaseClass(BaseClass)
• in constructor call AbstractXClassManager constructor with a name that will be used to generate all the documents and spaces needed.

Since:

Application Manager 1.0RC1

Version:

$Id: $

See Also:

XClassManager

Field Summary

Fields inherited from interface com.xpn.xwiki.plugin.applicationmanager.core.doc.objects.classes.XClassManager

XWIKI_CLASS_SPACE_PREFIX, XWIKI_CLASS_SPACE_SUFFIX, XWIKI_CLASS_SUFFIX, XWIKI_CLASSSHEET_SPACE_SUFFIX, XWIKI_CLASSSHEET_SUFFIX, XWIKI_CLASSTEMPLATE_SPACE_SUFFIX, XWIKI_CLASSTEMPLATE_SUFFIX

Constructor Summary

protected	AbstractXClassManager(java.lang.String prefix) Constructor for AbstractXClassManager.
protected	AbstractXClassManager(java.lang.String spaceprefix, java.lang.String prefix) Constructor for AbstractXClassManager.
protected	AbstractXClassManager(java.lang.String spaceprefix, java.lang.String prefix, boolean dispatch) Constructor for AbstractXClassManager.

Method Summary

protected void	check(com.xpn.xwiki.XWikiContext context) Check if all necessary documents for manage this class in this context exists and update.
java.lang.String	createWhereClause(java.lang.Object[][] fieldDescriptors, java.util.List<java.lang.Object> 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.
T	getXObjectDocument(java.lang.String itemName, int objectId, boolean validate, com.xpn.xwiki.XWikiContext context) Get document by full name from item name itemName.
protected int	intFromBoolean(java.lang.Boolean value)
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).
T	newXObjectDocument(java.lang.String docFullName, int objId, com.xpn.xwiki.XWikiContext context) Create new super document containing object of class XClassManager.getClassFullName().
T	newXObjectDocument(com.xpn.xwiki.XWikiContext context) Create new super document containing object of class XClassManager.getClassFullName().
T	newXObjectDocument(com.xpn.xwiki.doc.XWikiDocument doc, int objId, com.xpn.xwiki.XWikiContext context) Create new super document containing object of class XClassManager.getClassFullName().
java.util.List<T>	newXObjectDocumentList(java.util.List<com.xpn.xwiki.doc.XWikiDocument> documents, com.xpn.xwiki.XWikiContext context) Create new super document for each object of class XClassManager.getClassFullName() of each XWikiDocument in the list and return it.
java.util.List<T>	newXObjectDocumentList(com.xpn.xwiki.doc.XWikiDocument document, com.xpn.xwiki.XWikiContext context) Create new super documents for each object of class XClassManager.getClassFullName() for provided XWikiDocument and return it.
java.util.List<T>	searchXObjectDocuments(com.xpn.xwiki.XWikiContext context) Find all XWikiDocument containing object of this XWiki class.
java.util.List<T>	searchXObjectDocumentsByField(java.lang.String fieldName, java.lang.Object fieldValue, java.lang.String fieldType, com.xpn.xwiki.XWikiContext context) Search in instances of this document class.
java.util.List<T>	searchXObjectDocumentsByFields(java.lang.Object[][] fieldDescriptors, com.xpn.xwiki.XWikiContext context) Search in instances of this document class.
protected boolean	updateBaseClass(com.xpn.xwiki.objects.classes.BaseClass baseClass) Configure BaseClass.
protected boolean	updateBooleanClassDefaultValue(com.xpn.xwiki.objects.classes.BaseClass baseClass, java.lang.String fieldName, java.lang.Boolean value) Set the default value of a boolean field of a XWiki class.
protected boolean	updateClassTemplateDocument(com.xpn.xwiki.doc.XWikiDocument doc) Initialize template document with default content.
protected boolean	updateDocBooleanValue(com.xpn.xwiki.doc.XWikiDocument doc, java.lang.String fieldName, java.lang.Boolean value) Set the value of a boolean field in a document.
protected boolean	updateDocStringValue(com.xpn.xwiki.doc.XWikiDocument doc, java.lang.String fieldName, java.lang.String value) Set the value of a boolean field in a document.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractXClassManager

protected AbstractXClassManager(java.lang.String prefix)

Constructor for AbstractXClassManager.

Parameters:

prefix - the prefix of class document.

See Also:

AbstractXClassManager(String, String), AbstractXClassManager(String, String, boolean)

AbstractXClassManager

protected AbstractXClassManager(java.lang.String spaceprefix,
                                java.lang.String prefix)

Constructor for AbstractXClassManager.

Parameters:

spaceprefix - the space prefix of class document.

prefix - the prefix of class document.

See Also:

AbstractXClassManager(String), AbstractXClassManager(String, String, boolean)

AbstractXClassManager

protected AbstractXClassManager(java.lang.String spaceprefix,
                                java.lang.String prefix,
                                boolean dispatch)

Constructor for AbstractXClassManager.

Parameters:

spaceprefix - the space of class document.

prefix - the prefix of class document.

dispatch - Indicate if it had to use standard XWiki applications space names.

See Also:

AbstractXClassManager(String), AbstractXClassManager(String, String)

Method Detail

getClassSpacePrefix

public java.lang.String getClassSpacePrefix()

Specified by:

getClassSpacePrefix in interface XClassManager<T extends XObjectDocument>

Returns:

the space prefix name of the document containing the class.

See Also:

XClassManager.getClassSpacePrefix()

getClassSpace

public java.lang.String getClassSpace()

Specified by:

getClassSpace in interface XClassManager<T extends XObjectDocument>

Returns:

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

See Also:

XClassManager.getClassSpace()

getClassPrefix

public java.lang.String getClassPrefix()

Specified by:

getClassPrefix in interface XClassManager<T extends XObjectDocument>

Returns:

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

See Also:

XClassManager.getClassPrefix()

getClassName

public java.lang.String getClassName()

Specified by:

getClassName in interface XClassManager<T extends XObjectDocument>

Returns:

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

See Also:

XClassManager.getClassName()

getClassFullName

public java.lang.String getClassFullName()

Specified by:

getClassFullName in interface XClassManager<T extends XObjectDocument>

Returns:

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

See Also:

XClassManager.getClassFullName()

getClassTemplateSpace

public java.lang.String getClassTemplateSpace()

Specified by:

getClassTemplateSpace in interface XClassManager<T extends XObjectDocument>

Returns:

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

See Also:

XClassManager.getClassTemplateName()

getClassTemplateName

public java.lang.String getClassTemplateName()

Specified by:

getClassTemplateName in interface XClassManager<T extends XObjectDocument>

Returns:

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

See Also:

XClassManager.getClassTemplateName()

getClassTemplateFullName

public java.lang.String getClassTemplateFullName()

Specified by:

getClassTemplateFullName in interface XClassManager<T extends XObjectDocument>

Returns:

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

See Also:

XClassManager.getClassTemplateFullName()

getClassSheetSpace

public java.lang.String getClassSheetSpace()

Specified by:

getClassSheetSpace in interface XClassManager<T extends XObjectDocument>

Returns:

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

See Also:

XClassManager.getClassSheetName()

getClassSheetName

public java.lang.String getClassSheetName()

Specified by:

getClassSheetName in interface XClassManager<T extends XObjectDocument>

Returns:

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

See Also:

XClassManager.getClassSheetName()

getClassSheetFullName

public java.lang.String getClassSheetFullName()

Specified by:

getClassSheetFullName in interface XClassManager<T extends XObjectDocument>

Returns:

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

See Also:

XClassManager.getClassSheetFullName()

check

protected void check(com.xpn.xwiki.XWikiContext context)
              throws com.xpn.xwiki.XWikiException

Check if all necessary documents for manage this class in this context exists and update. Create if not exists. Thread safe.

Parameters:

context - the XWiki context.

Throws:

com.xpn.xwiki.XWikiException - error when saving documents.

See Also:

checkClassDocument(XWikiContext)

getClassSheetDefaultContent

public java.lang.String getClassSheetDefaultContent()

Specified by:

getClassSheetDefaultContent in interface XClassManager<T extends XObjectDocument>

Returns:

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

See Also:

XClassManager.getClassSheetDefaultContent()

getClassTemplateDefaultContent

public java.lang.String getClassTemplateDefaultContent()

Specified by:

getClassTemplateDefaultContent in interface XClassManager<T extends XObjectDocument>

Returns:

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

See Also:

XClassManager.getClassTemplateDefaultContent()

intFromBoolean

protected int intFromBoolean(java.lang.Boolean value)

Parameters:

value - the Boolean value to convert.

Returns:

the converted int value.

updateClassTemplateDocument

protected boolean updateClassTemplateDocument(com.xpn.xwiki.doc.XWikiDocument doc)

Initialize template document with default content.

Parameters:

doc - the class template document that will be saved.

Returns:

true if doc modified.

updateDocStringValue

protected boolean updateDocStringValue(com.xpn.xwiki.doc.XWikiDocument doc,
                                       java.lang.String fieldName,
                                       java.lang.String value)

Set the value of a boolean field in a document.

Parameters:

doc - the document to modify.

fieldName - the name of the field.

value - the value.

Returns:

true if doc modified.

updateDocBooleanValue

protected boolean updateDocBooleanValue(com.xpn.xwiki.doc.XWikiDocument doc,
                                        java.lang.String fieldName,
                                        java.lang.Boolean value)

Set the value of a boolean field in a document.

Parameters:

doc - the document to modify.

fieldName - the name of the field.

value - the value.

Returns:

true if doc modified.

updateBaseClass

protected boolean updateBaseClass(com.xpn.xwiki.objects.classes.BaseClass baseClass)

Configure BaseClass.

Parameters:

baseClass - the baseClass to configure.

Returns:

true if baseClass modified.

updateBooleanClassDefaultValue

protected boolean updateBooleanClassDefaultValue(com.xpn.xwiki.objects.classes.BaseClass baseClass,
                                                 java.lang.String fieldName,
                                                 java.lang.Boolean value)

Set the default value of a boolean field of a XWiki class.

Parameters:

baseClass - the XWiki class.

fieldName - the name of the field.

value - the default value.

Returns:

true if baseClass modified.

getBaseClass

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

Specified by:

getBaseClass in interface XClassManager<T extends XObjectDocument>

Returns:

the BaseClass managed by this SuperClass.

See Also:

XClassManager.getBaseClass()

getClassDocument

public 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.

Specified by:

getClassDocument in interface XClassManager<T extends XObjectDocument>

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.

See Also:

XClassManager.getClassDocument(com.xpn.xwiki.XWikiContext)

getClassSheetDocument

public 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.

Specified by:

getClassSheetDocument in interface XClassManager<T extends XObjectDocument>

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.

See Also:

XClassManager.getClassSheetDocument(com.xpn.xwiki.XWikiContext)

getClassTemplateDocument

public 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.

Specified by:

getClassTemplateDocument in interface XClassManager<T extends XObjectDocument>

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.

See Also:

XClassManager.getClassTemplateDocument(com.xpn.xwiki.XWikiContext)

isInstance

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

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

Specified by:

isInstance in interface XClassManager<T extends XObjectDocument>

Parameters:

doc - the XWikidocument to test.

Returns:

true if doc support this class, false otherwise.

See Also:

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

isInstance

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

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

Specified by:

isInstance in interface XClassManager<T extends XObjectDocument>

Parameters:

doc - the XWikidocument to test.

Returns:

true if doc support this class, false otherwise.

See Also:

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

getItemDocumentDefaultName

public 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.

Specified by:

getItemDocumentDefaultName in interface XClassManager<T extends XObjectDocument>

Parameters:

itemName - the name of the item to find.

context - the XWiki context.

Returns:

the name of the document.

See Also:

XClassManager.getItemDocumentDefaultName(java.lang.String, XWikiContext)

getItemDocumentDefaultFullName

public 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.

Specified by:

getItemDocumentDefaultFullName in interface XClassManager<T extends XObjectDocument>

Parameters:

itemName - the name of the item.

context - the XWiki context.

Returns:

the full name of the document.

See Also:

XClassManager.getItemDocumentDefaultFullName(java.lang.String, XWikiContext)

getItemDefaultName

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

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

Specified by:

getItemDefaultName in interface XClassManager<T extends XObjectDocument>

Parameters:

docFullName - the full name of the document.

Returns:

the item name extracted from document name.

See Also:

XClassManager.getItemDefaultName(java.lang.String)

getXObjectDocument

public T getXObjectDocument(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.

Specified by:

getXObjectDocument in interface XClassManager<T extends XObjectDocument>

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 T 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:

XClassManager.getXObjectDocument(java.lang.String, int, boolean, com.xpn.xwiki.XWikiContext)

createWhereClause

public java.lang.String createWhereClause(java.lang.Object[][] fieldDescriptors,
                                          java.util.List<java.lang.Object> parameterValues)

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

Specified by:

createWhereClause in interface XClassManager<T extends XObjectDocument>

Parameters:

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

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

Returns:

a HQL where clause.

searchXObjectDocuments

public java.util.List<T> searchXObjectDocuments(com.xpn.xwiki.XWikiContext context)
                                                                 throws com.xpn.xwiki.XWikiException

Find all XWikiDocument containing object of this XWiki class.

Parameters:

context - the XWiki context.

Returns:

the list of found XObjectDocument.

Throws:

com.xpn.xwiki.XWikiException - error when searching for document in database.

See Also:

getClassFullName()

searchXObjectDocumentsByField

public java.util.List<T> searchXObjectDocumentsByField(java.lang.String fieldName,
                                                       java.lang.Object fieldValue,
                                                       java.lang.String fieldType,
                                                       com.xpn.xwiki.XWikiContext context)
                                                                        throws com.xpn.xwiki.XWikiException

Search in instances of this document class.

Parameters:

fieldName - the name of field.

fieldValue - the value of field.

fieldType - the type of field.

context - the XWiki context.

Returns:

the list of found T.

Throws:

com.xpn.xwiki.XWikiException - error when searching for documents from in database.

searchXObjectDocumentsByFields

public java.util.List<T> searchXObjectDocumentsByFields(java.lang.Object[][] fieldDescriptors,
                                                        com.xpn.xwiki.XWikiContext context)
                                                                         throws com.xpn.xwiki.XWikiException

Search in instances of this document class.

Parameters:

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

context - the XWiki context.

Returns:

the list of found XObjectDocument.

Throws:

com.xpn.xwiki.XWikiException - error when searching for documents from in database.

newXObjectDocument

public T newXObjectDocument(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 XClassManager.getClassFullName(). If document already exist it is returned with new object if it does not contains any.

Specified by:

newXObjectDocument in interface XClassManager<T extends XObjectDocument>

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 XObjectDocument instance.

Throws:

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

See Also:

XClassManager.newXObjectDocument(com.xpn.xwiki.doc.XWikiDocument, int, com.xpn.xwiki.XWikiContext)

newXObjectDocument

public T newXObjectDocument(java.lang.String docFullName,
                            int objId,
                            com.xpn.xwiki.XWikiContext context)
                                             throws com.xpn.xwiki.XWikiException

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

Specified by:

newXObjectDocument in interface XClassManager<T extends XObjectDocument>

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 XObjectDocument instance.

Throws:

com.xpn.xwiki.XWikiException - error when calling T constructor.

See Also:

XClassManager.newXObjectDocument(java.lang.String, int, com.xpn.xwiki.XWikiContext)

newXObjectDocument

public T newXObjectDocument(com.xpn.xwiki.XWikiContext context)
                                             throws com.xpn.xwiki.XWikiException

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

Specified by:

newXObjectDocument in interface XClassManager<T extends XObjectDocument>

Parameters:

context - the XWiki context.

Returns:

a new T instance.

Throws:

com.xpn.xwiki.XWikiException - error when calling T constructor.

See Also:

XClassManager.newXObjectDocument(com.xpn.xwiki.XWikiContext)

newXObjectDocumentList

public java.util.List<T> newXObjectDocumentList(com.xpn.xwiki.doc.XWikiDocument document,
                                                com.xpn.xwiki.XWikiContext context)
                                                                 throws com.xpn.xwiki.XWikiException

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

Specified by:

newXObjectDocumentList in interface XClassManager<T extends XObjectDocument>

Parameters:

document - the list of XWikiDocument.

context - the XWiki context.

Returns:

the list of T.

Throws:

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

See Also:

XClassManager.newXObjectDocumentList(com.xpn.xwiki.doc.XWikiDocument, com.xpn.xwiki.XWikiContext)

newXObjectDocumentList

public java.util.List<T> newXObjectDocumentList(java.util.List<com.xpn.xwiki.doc.XWikiDocument> documents,
                                                com.xpn.xwiki.XWikiContext context)
                                                                 throws com.xpn.xwiki.XWikiException

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

Specified by:

newXObjectDocumentList in interface XClassManager<T extends XObjectDocument>

Parameters:

documents - the list of XWikiDocument.

context - the XWiki context.

Returns:

the list of T.

Throws:

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

See Also:

XClassManager.newXObjectDocumentList(java.util.List, com.xpn.xwiki.XWikiContext)