com.xpn.xwiki.plugin.applicationmanager.doc
Class XWikiApplication

java.lang.Object
  com.xpn.xwiki.api.Api
      com.xpn.xwiki.api.Document
          com.xpn.xwiki.plugin.applicationmanager.core.doc.objects.classes.DefaultSuperDocument
              com.xpn.xwiki.plugin.applicationmanager.doc.XWikiApplication

All Implemented Interfaces:

SuperDocument

public class XWikiApplication
extends DefaultSuperDocument

This class manage an XWiki document containing XApp.XWikiApplicationClass object. It add some specifics methods, getters and setters for this type of object and fields.

Version:

$Id: $

See Also:

DefaultSuperDocument

Field Summary

Fields inherited from class com.xpn.xwiki.plugin.applicationmanager.core.doc.objects.classes.DefaultSuperDocument

isNew, objectId, sclass

Fields inherited from class com.xpn.xwiki.api.Document

cloned, currentObj, doc

Fields inherited from class com.xpn.xwiki.api.Api

context

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

SPACE_DOC_SEPARATOR, WIKI_SPACE_SEPARATOR

Constructor Summary

XWikiApplication(com.xpn.xwiki.doc.XWikiDocument xdoc, int objectId, com.xpn.xwiki.XWikiContext context)
Create new XWikiApplication managing provided XWikiDocument.

Method Summary

protected void	addXWikiApplicationSet(XWikiApplication rootApplication, java.util.Collection applicationList, boolean recurse, com.xpn.xwiki.XWikiContext context) Add all applications on which current application depend.
boolean	equals(java.lang.Object object)
java.lang.String	getAppAuthors()
java.util.List	getApplications()
java.lang.String	getAppName()
java.lang.String	getAppVersion()
java.util.List	getDependencies()
java.lang.String	getDescription()
java.util.Set	getDocsNameToInclude(boolean recurse) Get and resolve all documents names to include application contains.
static java.util.Set	getDocsNameToInclude(java.util.Collection applications) Get and resolve all documents names to include applications XWikiApplication list contains.
java.util.Set	getDocsNameToLink(boolean recurse) Get and resolve all documents names to link application contains.
static java.util.Set	getDocsNameToLink(java.util.Collection applications) Get and resolve all documents names to link applications XWikiApplication list contains.
java.util.List	getDocsToInclude()
java.util.List	getDocsToLink()
java.util.List	getDocuments()
java.util.Set	getDocumentsNames(boolean recurse, boolean includeAppDesc) Get and resolve all documents names application contains.
java.lang.String	getLicense()
java.util.List	getTranslationDocs()
java.util.Set	getXWikiApplicationSet(boolean recurse, com.xpn.xwiki.XWikiContext context) Get set of XWikiApplication containing all applications on which current application depend.
int	hashCode()
void	setAppAuthors(java.lang.String appauthors) Modify the authors of the application.
void	setApplications(java.util.List applications) Modify the list of other applications on which current application depends.
void	setAppName(java.lang.String appname) Modify the name of the application.
void	setAppVersion(java.lang.String appversion) Modify the version of the application.
void	setDependencies(java.util.List dependencies) Modify the list of plugins on which application depends.
void	setDescription(java.lang.String description) Modify the description of the application.
void	setDocsToInclude(java.util.List docstoinclude) Modify the list of document application contains that will be included in place of copy from wiki template.
void	setDocsToLink(java.util.List docstolink) Modify the list of document application contains that will be included in place of copy from wiki template.
void	setDocuments(java.util.List documents) Modify the list of documents application contains.
void	setLicense(java.lang.String license) Modify the version of the application.
void	setTranslationDocs(java.util.List translationdocs) Modify the list of documents containing translations strings.
java.lang.String	toString()

Methods inherited from class com.xpn.xwiki.plugin.applicationmanager.core.doc.objects.classes.DefaultSuperDocument

deleteDocument, getBaseObject, getBooleanValue, getDocumentApi, getIntValue, getLargeStringValue, getListValue, getObjectApi, getObjectId, getStringValue, getSuperClass, isNew, mergeObject, reload, saveDocument, setBooleanValue, setFullName, setIntValue, setLargeStringValue, setListValue, setStringValue

Methods inherited from class com.xpn.xwiki.api.Document

addAttachment, addAttachment, addAttachments, addAttachments, addObjectFromRequest, addObjectFromRequest, addObjectFromRequest, addObjectsFromRequest, addObjectsFromRequest, checkAccess, createNewObject, delete, deleteWithProgrammingRights, display, display, display, display, display, display, displayEdit, displayForm, displayForm, displayForm, displayHidden, displayPrettyName, displayPrettyName, displayPrettyName, displayPrettyName, displayPrettyName, displayPrettyName, displayRendered, displayTooltip, displayTooltip, displayView, get, getActiveClass, getArchive, getAttachment, getAttachmentDiff, getAttachmentList, getAttachmentRevisionURL, getAttachmentRevisionURL, getAttachmentURL, getAttachmentURL, getAttachmentURL, getAuthor, getBacklinks, getClassDiff, getComment, getComments, getComments, getContent, getContentAuthor, getContentDiff, getContentUpdateDate, getCreationDate, getCreator, getCurrentMonthPageStats, getCurrentMonthRefStats, getCurrentMonthWebStats, getDate, getDefaultEditURL, getDefaultLanguage, getDefaultTemplate, getDisplayTitle, getDoc, getDocument, getDocumentArchive, getDocumentRevision, getEditURL, getEditURL, getEscapedContent, getExternalURL, getExternalURL, getExternalURL, getFirstObject, getFormat, getFullName, getId, getIncludedMacros, getIncludedPages, getLanguage, getLastChanges, getLinkedPages, getLinks, getLocked, getLockingDate, getLockingUser, getMetaDataDiff, getName, getObject, getObject, getObject, getObject, getObject, getObjectDiff, getObjectNumbers, getObjects, getObjects, getParent, getParentURL, getPrefixedFullName, getPreviousDocument, getPreviousVersion, getRCSVersion, getRealLanguage, getRecentRevisions, getRecentRevisions, getRenderedContent, getRenderedContent, getRenderedContentDiff, getRevisionInfo, getRevisions, getSpace, getTagList, getTags, getTagsPossibleValues, getTemplate, getTextArea, getTitle, getTOC, getTranslatedContent, getTranslatedContent, getTranslatedDocument, getTranslatedDocument, getTranslationList, getURL, getURL, getURL, getValue, getValue, getVersion, getVersionHashCode, getWeb, getWiki, getXMLContent, getXMLDiff, getxWikiClass, getxWikiClasses, getxWikiObjects, hasAccessLevel, hasAccessLevel, insertText, isAdvancedContent, isCreator, isCurrentLocalUserPage, isCurrentUserCreator, isCurrentUserPage, isFromCache, isMinorEdit, isMostRecent, isProgrammaticContent, newObject, removeObject, removeObjects, rename, rename, renameDocument, renameDocument, save, save, saveWithProgrammingRights, saveWithProgrammingRights, set, set, setComment, setContent, setCustomClass, setDefaultTemplate, setMinorEdit, setParent, setTitle, toXML, toXMLDocument, updateObjectFromRequest, updateObjectFromRequest, updateObjectsFromRequest, updateObjectsFromRequest, use, use, use, validate, validate

Methods inherited from class com.xpn.xwiki.api.Api

checkProgrammingRights, getXWikiContext, hasAdminRights, hasProgrammingRights

Methods inherited from class java.lang.Object

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

Constructor Detail

XWikiApplication

public XWikiApplication(com.xpn.xwiki.doc.XWikiDocument xdoc,
                        int objectId,
                        com.xpn.xwiki.XWikiContext context)
                 throws com.xpn.xwiki.XWikiException

Create new XWikiApplication managing provided XWikiDocument.

Parameters:

xdoc - the encapsulated XWikiDocument

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

context - the XWiki context

Throws:

com.xpn.xwiki.XWikiException - error when:

• getting XWikiApplicationClass instance.
• or when calling DefaultSuperDocument.reload(XWikiContext)

See Also:

DefaultSuperDocument.DefaultSuperDocument(com.xpn.xwiki.plugin.applicationmanager.core.doc.objects.classes.SuperClass, XWikiDocument, int, XWikiContext)

Method Detail

getAppName

public java.lang.String getAppName()

Returns:

the name of the application

See Also:

setAppName(String)

setAppName

public void setAppName(java.lang.String appname)

Modify the name of the application.

Parameters:

appname - the new name of the application.

See Also:

getAppName()

getDescription

public java.lang.String getDescription()

Returns:

the description of the application.

See Also:

setDescription(String)

setDescription

public void setDescription(java.lang.String description)

Modify the description of the application.

Parameters:

description - the new description of the application.

See Also:

getDescription()

getAppVersion

public java.lang.String getAppVersion()

Returns:

the version of the application.

See Also:

setAppVersion(String)

setAppVersion

public void setAppVersion(java.lang.String appversion)

Modify the version of the application.

Parameters:

appversion - the version of the application.

See Also:

getAppVersion()

getAppAuthors

public java.lang.String getAppAuthors()

Returns:

the authors of the application.

See Also:

setAppAuthors(String)

setAppAuthors

public void setAppAuthors(java.lang.String appauthors)

Modify the authors of the application.

Parameters:

appauthors - the authors of the application.

See Also:

getAppAuthors()

getLicense

public java.lang.String getLicense()

Returns:

the license of the application.

See Also:

setLicense(String)

setLicense

public void setLicense(java.lang.String license)

Modify the version of the application.

Parameters:

license - the license of the application.

See Also:

getAppVersion()

getDependencies

public java.util.List getDependencies()

Returns:

the list of plugins on which application depends.

See Also:

setDependencies(List)

setDependencies

public void setDependencies(java.util.List dependencies)

Modify the list of plugins on which application depends.

Parameters:

dependencies - the new list of plugins on which application depends.

See Also:

getDependencies()

getApplications

public java.util.List getApplications()

Returns:

the list of other applications on which current application depends.

setApplications

public void setApplications(java.util.List applications)

Modify the list of other applications on which current application depends.

Parameters:

applications - the new list of other applications on which current application depends.

See Also:

getApplications()

getDocuments

public java.util.List getDocuments()

Returns:

the list of documents application contains.

See Also:

setDocuments(List)

setDocuments

public void setDocuments(java.util.List documents)

Modify the list of documents application contains.

Parameters:

documents - the new list of documents application contains.

See Also:

getDocuments()

getDocsToInclude

public java.util.List getDocsToInclude()

Returns:

the list of document application contains that will be included in place of copy from wiki template.

See Also:

setDocsToInclude(List)

setDocsToInclude

public void setDocsToInclude(java.util.List docstoinclude)

Modify the list of document application contains that will be included in place of copy from wiki template.

Parameters:

docstoinclude - the new list of document application contains that will be included in place of copy from a wiki template.

See Also:

getDocsToInclude()

getDocsToLink

public java.util.List getDocsToLink()

Returns:

the list of document application contains that will be linked in place of copy from a wiki template.

See Also:

setDocsToLink(List)

setDocsToLink

public void setDocsToLink(java.util.List docstolink)

Modify the list of document application contains that will be included in place of copy from wiki template.

Parameters:

docstolink - the new list of document application contains that will be linked in place of copy from a wiki template.

See Also:

getDocsToLink()

getTranslationDocs

public java.util.List getTranslationDocs()

Returns:

the list of documents containing translations strings.

Theses documents are added to XWiki.XWikiPreferences "documentBundles" field at application installation.

setTranslationDocs

public void setTranslationDocs(java.util.List translationdocs)

Modify the list of documents containing translations strings.

Theses documents are added to XWiki.XWikiPreferences "documentBundles" field at application installation.

Parameters:

translationdocs - the new list of documents containing translations strings. Theses documents are added to XWiki.XWikiPreferences "documentBundles" field at application installation.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class com.xpn.xwiki.api.Document

See Also:

Document.equals(java.lang.Object)

addXWikiApplicationSet

protected void addXWikiApplicationSet(XWikiApplication rootApplication,
                                      java.util.Collection applicationList,
                                      boolean recurse,
                                      com.xpn.xwiki.XWikiContext context)
                               throws com.xpn.xwiki.XWikiException

Add all applications on which current application depend.

Parameters:

rootApplication - the root application containing recursively all in applicationList.

applicationList - the applications.

recurse - if true it add recursively all applications dependencies, if false return only direct dependencies.

context - the XWiki context.

Throws:

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

See Also:

getApplications()

getXWikiApplicationSet

public java.util.Set getXWikiApplicationSet(boolean recurse,
                                            com.xpn.xwiki.XWikiContext context)
                                     throws com.xpn.xwiki.XWikiException

Get set of XWikiApplication containing all applications on which current application depend.

Parameters:

recurse - if true it add recursively all applications dependencies, if false return only direct dependencies.

context - the XWiki context.

Returns:

the set list of XWikiApplication.

Throws:

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

See Also:

getApplications()

getDocumentsNames

public java.util.Set getDocumentsNames(boolean recurse,
                                       boolean includeAppDesc)
                                throws com.xpn.xwiki.XWikiException

Get and resolve all documents names application contains.

For each of these documents names, if are between "[" and "]", are considered as SQL matching string to use with "like".

Parameters:

recurse - if true it follow recursively all applications dependencies, if false parse only direct dependencies.

includeAppDesc - if true application descriptor document names is add to docsNames.

Returns:

all documents names application contains.

Throws:

com.xpn.xwiki.XWikiException - error when:

• resolving SQL matching.
• or getting applications dependencies descriptors documents from the database.

See Also:

getDocuments(), XWikiApplicationClass.FIELD_DOCUMENTS

getDocsNameToInclude

public java.util.Set getDocsNameToInclude(boolean recurse)
                                   throws com.xpn.xwiki.XWikiException

Get and resolve all documents names to include application contains.

For each of these documents names, if are between "[" and "]", are considered as SQL matching string to use with "like".

Parameters:

recurse - if true it follow recursively all applications dependencies, if false parse only direct dependencies.

Returns:

all documents names to include application contains.

Throws:

com.xpn.xwiki.XWikiException - error when:

• resolving SQL matching.
• or getting applications dependencies descriptors documents from the database.

See Also:

getDocsToInclude(), XWikiApplicationClass.FIELD_DOCSTOINCLUDE

getDocsNameToInclude

public static java.util.Set getDocsNameToInclude(java.util.Collection applications)
                                          throws com.xpn.xwiki.XWikiException

Get and resolve all documents names to include applications XWikiApplication list contains.

For each of these documents names, if are between "[" and "]", are considered as SQL matching string to use with "like".

Parameters:

applications - the applications containing documents names to resolve and add to docsNames.

Returns:

all documents names to include applications contains.

Throws:

com.xpn.xwiki.XWikiException - error when:

• resolving SQL matching.
• or getting applications dependencies descriptors documents from the database.

See Also:

getDocsToInclude(), XWikiApplicationClass.FIELD_DOCSTOINCLUDE

getDocsNameToLink

public java.util.Set getDocsNameToLink(boolean recurse)
                                throws com.xpn.xwiki.XWikiException

Get and resolve all documents names to link application contains.

For each of these documents names, if are between "[" and "]", are considered as SQL matching string to use with "like".

Parameters:

recurse - if true it follow recursively all applications dependencies, if false parse only direct dependencies.

Returns:

all documents names to link application contains.

Throws:

com.xpn.xwiki.XWikiException - error when:

• resolving SQL matching.
• or getting applications dependencies descriptors documents from the database.

See Also:

getDocsToLink(), XWikiApplicationClass.FIELD_DOCSTOLINK

getDocsNameToLink

public static java.util.Set getDocsNameToLink(java.util.Collection applications)
                                       throws com.xpn.xwiki.XWikiException

Get and resolve all documents names to link applications XWikiApplication list contains.

For each of these documents names, if are between "[" and "]", are considered as SQL matching string to use with "like".

Parameters:

applications - the applications containing documents names to resolve and add to docsNames.

Returns:

all documents names to link applications contains.

Throws:

com.xpn.xwiki.XWikiException - error when:

• resolving SQL matching.
• or getting applications dependencies descriptors documents from the database.

See Also:

getDocsToLink(), XWikiApplicationClass.FIELD_DOCSTOLINK