com.xpn.xwiki.plugin.applicationmanager.core.doc.objects.classes
Class DefaultXObjectDocument

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

All Implemented Interfaces:

XObjectDocument

Direct Known Subclasses:

XWikiApplication

public class DefaultXObjectDocument
extends com.xpn.xwiki.api.Document
implements XObjectDocument

Default implementation of XObjectDocument. This class manage an XWiki document containing provided XWiki class. It add some specifics methods, getters and setters for this type of object and fields. It also override Document (and then XWikiDocument) isNew concept considering as new a document that does not contains an XWiki object of the provided XWiki class.

Since:

Application Manager 1.0RC1

Version:

$Id: $

See Also:

XObjectDocument, XClassManager

Field Summary

protected boolean	isNew true if this is a new document of this class (this document can exist but does not contains object of this class).
protected int	objectId The id of the XWiki object included in the document to manage.
protected XClassManager	sclass The class manager for this document.

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

SPACE_DOC_SEPARATOR, WIKI_SPACE_SEPARATOR

Constructor Summary

DefaultXObjectDocument(XClassManager<? extends XObjectDocument> sclass, com.xpn.xwiki.doc.XWikiDocument xdoc, int objectId, com.xpn.xwiki.XWikiContext context)
Create instance of DefaultXObjectDocument from provided XWikiDocument.

Method Summary

void	delete()
protected com.xpn.xwiki.objects.BaseObject	getBaseObject(boolean toWrite) Get the managed BaseObject.
java.lang.Boolean	getBooleanValue(java.lang.String fieldName) Get the value of the field fieldName of the managed object's class.
com.xpn.xwiki.api.Document	getDocumentApi()
int	getIntValue(java.lang.String fieldName) Get the value of the field fieldName of the managed object's class.
java.lang.String	getLargeStringValue(java.lang.String fieldName) Deprecated. Use getStringValue(String) which support LargeStringProperty and StringProperty.
java.util.List	getListValue(java.lang.String fieldName) Deprecated. Use getStringListValue(String) instead. Since 1.4.
com.xpn.xwiki.api.Object	getObjectApi()
int	getObjectId()
java.util.List<java.lang.String>	getStringListValue(java.lang.String fieldName) Get the value of the field fieldName of the managed object's class.
java.lang.String	getStringValue(java.lang.String fieldName) Get the value of the field fieldName of the managed object's class.
XClassManager	getXClassManager()
boolean	isNew()
void	mergeObject(DefaultXObjectDocument sdoc) Overwrite current BaseObject fields with provided one.
void	reload(com.xpn.xwiki.XWikiContext context) Reload XWiki document from database using Document full name.
protected void	saveDocument(java.lang.String comment, boolean minorEdit)
void	setBooleanValue(java.lang.String fieldName, java.lang.Boolean value) Modify the value of the field fieldName of the managed object's class.
void	setFullName(java.lang.String docFullName)
void	setIntValue(java.lang.String fieldName, int value) Modify the value of the field fieldName of the managed object's class.
void	setLargeStringValue(java.lang.String fieldName, java.lang.String value) Deprecated. Use setStringValue(String, String) which support LargeStringProperty and StringProperty.
void	setListValue(java.lang.String fieldName, java.util.List value) Deprecated. Use getStringListValue(String) instead. Since 1.4.
void	setStringListValue(java.lang.String fieldName, java.util.List<java.lang.String> value) Modify the value of the field fieldName of the managed object's class.
void	setStringValue(java.lang.String fieldName, java.lang.String value) Modify the value of the field fieldName of the managed object's class.

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

addAttachment, addAttachment, addAttachments, addAttachments, addObjectFromRequest, addObjectFromRequest, addObjectFromRequest, addObjectsFromRequest, addObjectsFromRequest, checkAccess, createNewObject, deleteDocument, deleteWithProgrammingRights, display, display, display, display, display, display, displayEdit, displayForm, displayForm, displayForm, displayHidden, displayPrettyName, displayPrettyName, displayPrettyName, displayPrettyName, displayPrettyName, displayPrettyName, displayRendered, displayTooltip, displayTooltip, displayView, equals, 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, getObjects, getParent, getParentURL, getPrefixedFullName, getPreviousDocument, getPreviousVersion, getRCSVersion, getRealLanguage, getRecentRevisions, getRecentRevisions, getRenderedContent, getRenderedContent, getRenderedContent, getRenderedContentDiff, getRevisionInfo, getRevisions, getRevisions, getSpace, getSyntaxId, getTagList, getTags, getTagsPossibleValues, getTemplate, getTextArea, getTitle, getTOC, getTranslatedContent, getTranslatedContent, getTranslatedDocument, getTranslatedDocument, getTranslationList, getURL, getURL, getURL, getValidationScript, 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, save, saveWithProgrammingRights, saveWithProgrammingRights, saveWithProgrammingRights, set, set, setComment, setContent, setCustomClass, setDefaultTemplate, setMinorEdit, setParent, setTitle, setValidationScript, toString, toXML, toXMLDocument, updateObjectFromRequest, updateObjectFromRequest, updateObjectsFromRequest, updateObjectsFromRequest, use, use, use, validate, validate

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

checkProgrammingRights, convert, convert, getXWikiContext, hasAdminRights, hasProgrammingRights

Methods inherited from class java.lang.Object

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

Field Detail

sclass

protected XClassManager sclass

The class manager for this document.

objectId

protected int objectId

The id of the XWiki object included in the document to manage.

isNew

protected boolean isNew

true if this is a new document of this class (this document can exist but does not contains object of this class).

Constructor Detail

DefaultXObjectDocument

public DefaultXObjectDocument(XClassManager<? extends XObjectDocument> sclass,
                              com.xpn.xwiki.doc.XWikiDocument xdoc,
                              int objectId,
                              com.xpn.xwiki.XWikiContext context)
                       throws com.xpn.xwiki.XWikiException

Create instance of DefaultXObjectDocument from provided XWikiDocument.

Parameters:

sclass - the class manager for this document.

xdoc - the XWikiDocument to manage.

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

context - the XWiki context.

Throws:

com.xpn.xwiki.XWikiException - error when calling reload(XWikiContext).

Method Detail

setFullName

public void setFullName(java.lang.String docFullName)

Parameters:

docFullName - modify the full name the the managed XWikiDocument.

reload

public void reload(com.xpn.xwiki.XWikiContext context)
            throws com.xpn.xwiki.XWikiException

Reload XWiki document from database using Document full name.

Specified by:

reload in interface XObjectDocument

Parameters:

context - the XWiki context.

Throws:

com.xpn.xwiki.XWikiException - error when initialize document.

See Also:

XObjectDocument.reload(com.xpn.xwiki.XWikiContext)

getDocumentApi

public com.xpn.xwiki.api.Document getDocumentApi()

Specified by:

getDocumentApi in interface XObjectDocument

Returns:

the document.

See Also:

XObjectDocument.getDocumentApi()

getObjectId

public int getObjectId()

Specified by:

getObjectId in interface XObjectDocument

Returns:

the id of the managed XWiki object;

See Also:

XObjectDocument.getObjectId()

getObjectApi

public com.xpn.xwiki.api.Object getObjectApi()

Specified by:

getObjectApi in interface XObjectDocument

Returns:

the managed XWiki object.

See Also:

XObjectDocument.getObjectApi()

getBaseObject

protected com.xpn.xwiki.objects.BaseObject getBaseObject(boolean toWrite)

Get the managed BaseObject.

Parameters:

toWrite - indicate that the BaseObject will be modified.

Returns:

the BaseObject.

mergeObject

public void mergeObject(DefaultXObjectDocument sdoc)

Overwrite current BaseObject fields with provided one. Only provided non null fields are copied.

Parameters:

sdoc - the document to merge.

getXClassManager

public XClassManager getXClassManager()

Specified by:

getXClassManager in interface XObjectDocument

Returns:

the class manager for this document.

See Also:

XObjectDocument.getXClassManager()

isNew

public boolean isNew()

Specified by:

isNew in interface XObjectDocument

Overrides:

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

Returns:

true if this is a new document of this class (this document can exist but does not contains object of this class).

See Also:

XObjectDocument.isNew()

saveDocument

protected void saveDocument(java.lang.String comment,
                            boolean minorEdit)
                     throws com.xpn.xwiki.XWikiException

Overrides:

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

Throws:

com.xpn.xwiki.XWikiException

See Also:

Document.saveDocument(java.lang.String, boolean)

delete

public void delete()
            throws com.xpn.xwiki.XWikiException

Overrides:

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

Throws:

com.xpn.xwiki.XWikiException

See Also:

Document.delete()

getStringValue

public java.lang.String getStringValue(java.lang.String fieldName)

Get the value of the field fieldName of the managed object's class.

Parameters:

fieldName - the name of the field from the managed object's class where to find the value.

Returns:

the value in String of the field fieldName of the managed object's class.

See Also:

XWikiDocument.getStringValue(java.lang.String)

setStringValue

public void setStringValue(java.lang.String fieldName,
                           java.lang.String value)

Modify the value of the field fieldName of the managed object's class.

This method makes sure the right property type between LargeStringProperty and StringProperty is used.

Parameters:

fieldName - the name of the field from the managed object's class where to find the value.

value - the new value of the field fieldName of the managed object's class.

See Also:

XWikiDocument.setStringValue(java.lang.String,java.lang.String,java.lang.String)

getLargeStringValue

@Deprecated
public java.lang.String getLargeStringValue(java.lang.String fieldName)

Deprecated. Use getStringValue(String) which support LargeStringProperty and StringProperty.

Get the value of the field fieldName of the managed object's class.

Parameters:

fieldName - the name of the field from the managed object's class where to find the value.

Returns:

the value in String of the field fieldName of the managed object's class.

See Also:

XWikiDocument.getStringValue(java.lang.String)

setLargeStringValue

@Deprecated
public void setLargeStringValue(java.lang.String fieldName,
                                           java.lang.String value)

Deprecated. Use setStringValue(String, String) which support LargeStringProperty and StringProperty.

Modify the value of the field fieldName of the managed object's class.

This method makes sure the right property type between LargeStringProperty and StringProperty is used.

Parameters:

fieldName - the name of the field from the managed object's class where to find the value.

value - the new value of the field fieldName of the managed object's class.

See Also:

XWikiDocument.setLargeStringValue(java.lang.String,java.lang.String,java.lang.String)

getStringListValue

public java.util.List<java.lang.String> getStringListValue(java.lang.String fieldName)

Get the value of the field fieldName of the managed object's class.

Parameters:

fieldName - the name of the field from the managed object's class where to find the value.

Returns:

the value in List of the field fieldName of the managed object's class.

Since:

1.4

See Also:

XWikiDocument.getListValue(java.lang.String)

setStringListValue

public void setStringListValue(java.lang.String fieldName,
                               java.util.List<java.lang.String> value)

Modify the value of the field fieldName of the managed object's class.

Parameters:

fieldName - the name of the field from the managed object's class where to find the value.

value - the new value of the field fieldName of the managed object's class.

Since:

1.4

See Also:

XWikiDocument.setStringListValue(java.lang.String,java.lang.String,java.util.List)

getListValue

@Deprecated
public java.util.List getListValue(java.lang.String fieldName)

Deprecated. Use getStringListValue(String) instead. Since 1.4.

Get the value of the field fieldName of the managed object's class.

Parameters:

fieldName - the name of the field from the managed object's class where to find the value.

Returns:

the value in List of the field fieldName of the managed object's class.

See Also:

XWikiDocument.getListValue(java.lang.String)

setListValue

@Deprecated
public void setListValue(java.lang.String fieldName,
                                    java.util.List value)

Deprecated. Use getStringListValue(String) instead. Since 1.4.

Modify the value of the field fieldName of the managed object's class.

Parameters:

fieldName - the name of the field from the managed object's class where to find the value.

value - the new value of the field fieldName of the managed object's class.

See Also:

XWikiDocument.setStringListValue(java.lang.String,java.lang.String,java.util.List)

getIntValue

public int getIntValue(java.lang.String fieldName)

Get the value of the field fieldName of the managed object's class.

Parameters:

fieldName - the name of the field from the managed object's class where to find the value.

Returns:

the value in int of the field fieldName of the managed object's class.

See Also:

XWikiDocument.getListValue(java.lang.String)

setIntValue

public void setIntValue(java.lang.String fieldName,
                        int value)

Modify the value of the field fieldName of the managed object's class.

Parameters:

fieldName - the name of the field from the managed object's class where to find the value.

value - the new value of the field fieldName of the managed object's class.

See Also:

XWikiDocument.setIntValue(String, String, int)

getBooleanValue

public java.lang.Boolean getBooleanValue(java.lang.String fieldName)

Get the value of the field fieldName of the managed object's class.

Parameters:

fieldName - the name of the field from the managed object's class where to find the value.

Returns:

the value in Boolean of the field fieldName of the managed object's class.

See Also:

XWikiDocument.getListValue(java.lang.String)

setBooleanValue

public void setBooleanValue(java.lang.String fieldName,
                            java.lang.Boolean value)

Modify the value of the field fieldName of the managed object's class.

Parameters:

fieldName - the name of the field from the managed object's class where to find the value.

value - the new value of the field fieldName of the managed object's class.

See Also:

XWikiDocument.setIntValue(String, String, int)