com.xpn.xwiki.api
Class Document

java.lang.Object
  extended by com.xpn.xwiki.api.Api
      extended by com.xpn.xwiki.api.Document

public class Document
extends Api


Field Summary
private  Object currentObj
           
private  XWikiDocument doc
           
private  XWikiDocument olddoc
           
 
Fields inherited from class com.xpn.xwiki.api.Api
context
 
Constructor Summary
Document(XWikiDocument doc, XWikiContext context)
           
 
Method Summary
 Object addObjectFromRequest()
           
 boolean checkAccess(java.lang.String right)
           
 int createNewObject(java.lang.String classname)
           
 java.lang.String display(java.lang.String fieldname)
           
 java.lang.String display(java.lang.String fieldname, Object obj)
           
 java.lang.String display(java.lang.String fieldname, java.lang.String mode)
           
 java.lang.String display(java.lang.String fieldname, java.lang.String mode, Object obj)
           
 java.lang.String displayEdit(PropertyClass pclass, java.lang.String prefix, Collection object)
           
 java.lang.String displayForm(java.lang.String className)
           
 java.lang.String displayForm(java.lang.String className, java.lang.String header, java.lang.String format)
           
 java.lang.String displayForm(java.lang.String className, java.lang.String header, java.lang.String format, boolean linebreak)
           
 java.lang.String displayHidden(PropertyClass pclass, java.lang.String prefix, Collection object)
           
 java.lang.String displayRendered(PropertyClass pclass, java.lang.String prefix, Collection object)
           
 java.lang.String displaySearch(PropertyClass pclass, java.lang.String prefix, Collection object)
           
 java.lang.String displayView(PropertyClass pclass, java.lang.String prefix, Collection object)
           
 boolean equals(java.lang.Object arg0)
           
 java.lang.Object get(java.lang.String classOrFieldName)
           
 java.lang.String getArchive()
           
 Attachment getAttachment(java.lang.String filename)
           
 java.util.List getAttachmentList()
           
 java.lang.String getAttachmentRevisionURL(java.lang.String filename, java.lang.String version)
           
 java.lang.String getAttachmentRevisionURL(java.lang.String filename, java.lang.String version, java.lang.String querystring)
           
 java.lang.String getAttachmentURL(java.lang.String filename)
           
 java.lang.String getAttachmentURL(java.lang.String filename, java.lang.String action)
           
 java.lang.String getAttachmentURL(java.lang.String filename, java.lang.String action, java.lang.String querystring)
           
 java.lang.String getAuthor()
           
 java.util.List getBacklinks()
           
 java.util.List getClassDiff(Document origdoc, Document newdoc)
           
 java.util.Vector getComments()
           
 java.util.Vector getComments(boolean asc)
           
 java.lang.String getContent()
           
 java.lang.String getContentAuthor()
           
 java.util.List getContentDiff(Document origdoc, Document newdoc)
           
 java.util.Date getContentUpdateDate()
           
 java.util.Date getCreationDate()
           
 java.lang.String getCreator()
           
 DocumentStats getCurrentMonthPageStats(java.lang.String action)
           
 java.util.List getCurrentMonthRefStats()
           
 DocumentStats getCurrentMonthWebStats(java.lang.String action)
           
 java.util.Date getDate()
           
 java.lang.String getDefaultEditURL()
           
 java.lang.String getDefaultLanguage()
           
 java.lang.String getDefaultTemplate()
           
 java.lang.String getDisplayTitle()
           
protected  XWikiDocument getDoc()
           
 XWikiDocument getDocument()
           
 java.lang.String getEditURL(java.lang.String action, java.lang.String mode)
           
 java.lang.String getEditURL(java.lang.String action, java.lang.String mode, java.lang.String language)
           
 java.lang.String getEscapedContent()
           
 java.lang.String getExternalURL()
           
 java.lang.String getExternalURL(java.lang.String action)
           
 java.lang.String getExternalURL(java.lang.String action, java.lang.String querystring)
           
 Object getFirstObject(java.lang.String fieldname)
           
 java.lang.String getFormat()
           
 java.lang.String getFullName()
           
 long getId()
           
 java.util.List getIncludedMacros()
           
 java.util.List getIncludedPages()
           
 java.lang.String getLanguage()
           
 java.util.List getLastChanges()
           
 java.util.List getLinkedPages()
           
 java.util.List getLinks()
           
 boolean getLocked()
           
 java.util.Date getLockingDate()
           
 java.lang.String getLockingUser()
           
 java.util.List getMetaDataDiff(Document origdoc, Document newdoc)
           
 java.lang.String getName()
           
 Object getObject(java.lang.String classname)
           
 Object getObject(java.lang.String classname, boolean create)
           
 Object getObject(java.lang.String classname, int nb)
           
 Object getObject(java.lang.String classname, java.lang.String key, java.lang.String value)
           
 Object getObject(java.lang.String classname, java.lang.String key, java.lang.String value, boolean failover)
           
 java.util.List getObjectDiff(Document origdoc, Document newdoc)
           
 int getObjectNumbers(java.lang.String classname)
           
 java.util.Vector getObjects(java.lang.String classname)
           
protected  java.util.Vector getObjects(java.util.Vector objects)
           
 java.lang.String getParent()
           
 java.lang.String getParentURL()
           
 org.apache.commons.jrcs.rcs.Archive getRCSArchive()
           
 org.apache.commons.jrcs.rcs.Version getRCSVersion()
           
 java.lang.String getRealLanguage()
           
 java.lang.String[] getRecentRevisions()
           
 java.lang.String[] getRecentRevisions(int nb)
           
 java.lang.String getRenderedContent()
           
 java.lang.String getRenderedContent(java.lang.String text)
           
 java.util.List getRenderedContentDiff(Document origdoc, Document newdoc)
           
 org.apache.commons.jrcs.rcs.Version[] getRevisions()
           
 java.lang.String getTemplate()
           
 java.lang.String getTextArea()
           
 java.lang.String getTitle()
           
 java.util.Map getTOC(int init, int max, boolean numbered)
          Returns data needed for a generation of Table of Content for this document.
 java.lang.String getTranslatedContent()
           
 java.lang.String getTranslatedContent(java.lang.String language)
           
 Document getTranslatedDocument()
           
 Document getTranslatedDocument(java.lang.String language)
           
 java.util.List getTranslationList()
           
 java.lang.String getURL()
           
 java.lang.String getURL(java.lang.String action)
           
 java.lang.String getURL(java.lang.String action, java.lang.String querystring)
           
 java.lang.String getVersion()
           
 java.lang.String getWeb()
           
 java.lang.String getXMLContent()
           
 java.util.List getXMLDiff(Document origdoc, Document newdoc)
           
 Class getxWikiClass()
           
 Class[] getxWikiClasses()
           
 java.util.Map getxWikiObjects()
           
 boolean hasAccessLevel(java.lang.String level)
           
 boolean hasAccessLevel(java.lang.String level, java.lang.String user)
          check if the current user has the given right
 void insertText(java.lang.String text, java.lang.String marker)
           
 boolean isCreator(java.lang.String username)
           
 boolean isCurrentLocalUserPage()
           
 boolean isCurrentUserCreator()
           
 boolean isCurrentUserPage()
           
 boolean isFromCache()
           
 boolean isNew()
           
 Object newObject(java.lang.String classname)
           
private  Object newObjectApi(BaseObject obj, XWikiContext context)
           
 void save()
           
 void saveWithProgrammingRights()
           
 void set(java.lang.String fieldname, java.lang.Object value)
           
 void setContent(java.lang.String content)
           
 void setDefaultTemplate(java.lang.String dtemplate)
           
 void setParent(java.lang.String parent)
           
 void setTitle(java.lang.String title)
           
 java.lang.String toXML()
           
 org.dom4j.Document toXMLDocument()
           
 void use(Object object)
           
 void use(java.lang.String className)
           
 void use(java.lang.String className, int nb)
           
 
Methods inherited from class com.xpn.xwiki.api.Api
checkProgrammingRights, hasAdminRights, hasProgrammingRights
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

olddoc

private XWikiDocument olddoc

doc

private XWikiDocument doc

currentObj

private Object currentObj
Constructor Detail

Document

public Document(XWikiDocument doc,
                XWikiContext context)
Method Detail

getDocument

public XWikiDocument getDocument()

getDoc

protected XWikiDocument getDoc()

getId

public long getId()

getName

public java.lang.String getName()

getWeb

public java.lang.String getWeb()

getFullName

public java.lang.String getFullName()

getRCSVersion

public org.apache.commons.jrcs.rcs.Version getRCSVersion()

getVersion

public java.lang.String getVersion()

getTitle

public java.lang.String getTitle()

getDisplayTitle

public java.lang.String getDisplayTitle()

getFormat

public java.lang.String getFormat()

getAuthor

public java.lang.String getAuthor()

getContentAuthor

public java.lang.String getContentAuthor()

getDate

public java.util.Date getDate()

getContentUpdateDate

public java.util.Date getContentUpdateDate()

getCreationDate

public java.util.Date getCreationDate()

getParent

public java.lang.String getParent()

getCreator

public java.lang.String getCreator()

getContent

public java.lang.String getContent()

getLanguage

public java.lang.String getLanguage()

getTemplate

public java.lang.String getTemplate()

getRealLanguage

public java.lang.String getRealLanguage()
                                 throws XWikiException
Throws:
XWikiException

getDefaultLanguage

public java.lang.String getDefaultLanguage()

getDefaultTemplate

public java.lang.String getDefaultTemplate()

getTranslationList

public java.util.List getTranslationList()
                                  throws XWikiException
Throws:
XWikiException

getTranslatedContent

public java.lang.String getTranslatedContent()
                                      throws XWikiException
Throws:
XWikiException

getTranslatedContent

public java.lang.String getTranslatedContent(java.lang.String language)
                                      throws XWikiException
Throws:
XWikiException

getTranslatedDocument

public Document getTranslatedDocument(java.lang.String language)
                               throws XWikiException
Throws:
XWikiException

getTranslatedDocument

public Document getTranslatedDocument()
                               throws XWikiException
Throws:
XWikiException

getRenderedContent

public java.lang.String getRenderedContent()
                                    throws XWikiException
Throws:
XWikiException

getRenderedContent

public java.lang.String getRenderedContent(java.lang.String text)

getEscapedContent

public java.lang.String getEscapedContent()
                                   throws XWikiException
Throws:
XWikiException

getRCSArchive

public org.apache.commons.jrcs.rcs.Archive getRCSArchive()

getArchive

public java.lang.String getArchive()
                            throws XWikiException
Throws:
XWikiException

isNew

public boolean isNew()

getAttachmentURL

public java.lang.String getAttachmentURL(java.lang.String filename)

getAttachmentURL

public java.lang.String getAttachmentURL(java.lang.String filename,
                                         java.lang.String action)

getAttachmentURL

public java.lang.String getAttachmentURL(java.lang.String filename,
                                         java.lang.String action,
                                         java.lang.String querystring)

getAttachmentRevisionURL

public java.lang.String getAttachmentRevisionURL(java.lang.String filename,
                                                 java.lang.String version)

getAttachmentRevisionURL

public java.lang.String getAttachmentRevisionURL(java.lang.String filename,
                                                 java.lang.String version,
                                                 java.lang.String querystring)

getURL

public java.lang.String getURL()

getURL

public java.lang.String getURL(java.lang.String action)

getURL

public java.lang.String getURL(java.lang.String action,
                               java.lang.String querystring)

getExternalURL

public java.lang.String getExternalURL()

getExternalURL

public java.lang.String getExternalURL(java.lang.String action)

getExternalURL

public java.lang.String getExternalURL(java.lang.String action,
                                       java.lang.String querystring)

getParentURL

public java.lang.String getParentURL()
                              throws XWikiException
Throws:
XWikiException

getxWikiClass

public Class getxWikiClass()

getxWikiClasses

public Class[] getxWikiClasses()

createNewObject

public int createNewObject(java.lang.String classname)
                    throws XWikiException
Throws:
XWikiException

newObject

public Object newObject(java.lang.String classname)
                 throws XWikiException
Throws:
XWikiException

isFromCache

public boolean isFromCache()

getObjectNumbers

public int getObjectNumbers(java.lang.String classname)

getxWikiObjects

public java.util.Map getxWikiObjects()

getObjects

protected java.util.Vector getObjects(java.util.Vector objects)

getObjects

public java.util.Vector getObjects(java.lang.String classname)

getFirstObject

public Object getFirstObject(java.lang.String fieldname)

getObject

public Object getObject(java.lang.String classname,
                        java.lang.String key,
                        java.lang.String value,
                        boolean failover)

getObject

public Object getObject(java.lang.String classname,
                        java.lang.String key,
                        java.lang.String value)

getObject

public Object getObject(java.lang.String classname)

getObject

public Object getObject(java.lang.String classname,
                        boolean create)

getObject

public Object getObject(java.lang.String classname,
                        int nb)

newObjectApi

private Object newObjectApi(BaseObject obj,
                            XWikiContext context)

getXMLContent

public java.lang.String getXMLContent()
                               throws XWikiException
Throws:
XWikiException

toXML

public java.lang.String toXML()
                       throws XWikiException
Throws:
XWikiException

toXMLDocument

public org.dom4j.Document toXMLDocument()
                                 throws XWikiException
Throws:
XWikiException

getRevisions

public org.apache.commons.jrcs.rcs.Version[] getRevisions()
                                                   throws XWikiException
Throws:
XWikiException

getRecentRevisions

public java.lang.String[] getRecentRevisions()
                                      throws XWikiException
Throws:
XWikiException

getRecentRevisions

public java.lang.String[] getRecentRevisions(int nb)
                                      throws XWikiException
Throws:
XWikiException

getAttachmentList

public java.util.List getAttachmentList()

getComments

public java.util.Vector getComments()

getComments

public java.util.Vector getComments(boolean asc)

use

public void use(Object object)

use

public void use(java.lang.String className)

use

public void use(java.lang.String className,
                int nb)

display

public java.lang.String display(java.lang.String fieldname)

display

public java.lang.String display(java.lang.String fieldname,
                                java.lang.String mode)

display

public java.lang.String display(java.lang.String fieldname,
                                Object obj)

display

public java.lang.String display(java.lang.String fieldname,
                                java.lang.String mode,
                                Object obj)

displayForm

public java.lang.String displayForm(java.lang.String className,
                                    java.lang.String header,
                                    java.lang.String format)

displayForm

public java.lang.String displayForm(java.lang.String className,
                                    java.lang.String header,
                                    java.lang.String format,
                                    boolean linebreak)

displayForm

public java.lang.String displayForm(java.lang.String className)

displayRendered

public java.lang.String displayRendered(PropertyClass pclass,
                                        java.lang.String prefix,
                                        Collection object)

displayView

public java.lang.String displayView(PropertyClass pclass,
                                    java.lang.String prefix,
                                    Collection object)

displayEdit

public java.lang.String displayEdit(PropertyClass pclass,
                                    java.lang.String prefix,
                                    Collection object)

displayHidden

public java.lang.String displayHidden(PropertyClass pclass,
                                      java.lang.String prefix,
                                      Collection object)

displaySearch

public java.lang.String displaySearch(PropertyClass pclass,
                                      java.lang.String prefix,
                                      Collection object)

getIncludedPages

public java.util.List getIncludedPages()

getIncludedMacros

public java.util.List getIncludedMacros()

getLinkedPages

public java.util.List getLinkedPages()

getAttachment

public Attachment getAttachment(java.lang.String filename)

getContentDiff

public java.util.List getContentDiff(Document origdoc,
                                     Document newdoc)
                              throws XWikiException,
                                     org.apache.commons.jrcs.diff.DifferentiationFailedException
Throws:
XWikiException
org.apache.commons.jrcs.diff.DifferentiationFailedException

getXMLDiff

public java.util.List getXMLDiff(Document origdoc,
                                 Document newdoc)
                          throws XWikiException,
                                 org.apache.commons.jrcs.diff.DifferentiationFailedException
Throws:
XWikiException
org.apache.commons.jrcs.diff.DifferentiationFailedException

getRenderedContentDiff

public java.util.List getRenderedContentDiff(Document origdoc,
                                             Document newdoc)
                                      throws XWikiException,
                                             org.apache.commons.jrcs.diff.DifferentiationFailedException
Throws:
XWikiException
org.apache.commons.jrcs.diff.DifferentiationFailedException

getMetaDataDiff

public java.util.List getMetaDataDiff(Document origdoc,
                                      Document newdoc)
                               throws XWikiException
Throws:
XWikiException

getObjectDiff

public java.util.List getObjectDiff(Document origdoc,
                                    Document newdoc)
                             throws XWikiException
Throws:
XWikiException

getClassDiff

public java.util.List getClassDiff(Document origdoc,
                                   Document newdoc)
                            throws XWikiException
Throws:
XWikiException

getLastChanges

public java.util.List getLastChanges()
                              throws XWikiException,
                                     org.apache.commons.jrcs.diff.DifferentiationFailedException
Throws:
XWikiException
org.apache.commons.jrcs.diff.DifferentiationFailedException

getCurrentMonthPageStats

public DocumentStats getCurrentMonthPageStats(java.lang.String action)

getCurrentMonthWebStats

public DocumentStats getCurrentMonthWebStats(java.lang.String action)

getCurrentMonthRefStats

public java.util.List getCurrentMonthRefStats()
                                       throws XWikiException
Throws:
XWikiException

checkAccess

public boolean checkAccess(java.lang.String right)

hasAccessLevel

public boolean hasAccessLevel(java.lang.String level)

hasAccessLevel

public boolean hasAccessLevel(java.lang.String level,
                              java.lang.String user)
Description copied from class: Api
check if the current user has the given right

Overrides:
hasAccessLevel in class Api
Returns:
true if he has

getLocked

public boolean getLocked()

getLockingUser

public java.lang.String getLockingUser()

getLockingDate

public java.util.Date getLockingDate()

get

public java.lang.Object get(java.lang.String classOrFieldName)

getTextArea

public java.lang.String getTextArea()

getTOC

public java.util.Map getTOC(int init,
                            int max,
                            boolean numbered)
Returns data needed for a generation of Table of Content for this document.

Parameters:
init - an intial level where the TOC generation should start at
max - maximum level TOC is generated for
numbered - if should generate numbering for headings
Returns:
a map where an heading (title) ID is the key and value is another map with two keys: text, level and numbering

addObjectFromRequest

public Object addObjectFromRequest()
                            throws XWikiException
Throws:
XWikiException

insertText

public void insertText(java.lang.String text,
                       java.lang.String marker)
                throws XWikiException
Throws:
XWikiException

equals

public boolean equals(java.lang.Object arg0)
Overrides:
equals in class java.lang.Object

getBacklinks

public java.util.List getBacklinks()
                            throws XWikiException
Throws:
XWikiException

getLinks

public java.util.List getLinks()
                        throws XWikiException
Throws:
XWikiException

getDefaultEditURL

public java.lang.String getDefaultEditURL()
                                   throws XWikiException
Throws:
XWikiException

getEditURL

public java.lang.String getEditURL(java.lang.String action,
                                   java.lang.String mode)
                            throws XWikiException
Throws:
XWikiException

getEditURL

public java.lang.String getEditURL(java.lang.String action,
                                   java.lang.String mode,
                                   java.lang.String language)

isCurrentUserCreator

public boolean isCurrentUserCreator()

isCurrentUserPage

public boolean isCurrentUserPage()

isCurrentLocalUserPage

public boolean isCurrentLocalUserPage()

isCreator

public boolean isCreator(java.lang.String username)

set

public void set(java.lang.String fieldname,
                java.lang.Object value)

setTitle

public void setTitle(java.lang.String title)

setParent

public void setParent(java.lang.String parent)

setContent

public void setContent(java.lang.String content)

setDefaultTemplate

public void setDefaultTemplate(java.lang.String dtemplate)

save

public void save()
          throws XWikiException
Throws:
XWikiException

saveWithProgrammingRights

public void saveWithProgrammingRights()
                               throws XWikiException
Throws:
XWikiException


Copyright 2003 Ludovic Dubost