|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.xpn.xwiki.doc.XWikiDocumentArchive
public class XWikiDocumentArchive
Contains document history. Allows to load any version of document.
Constructor Summary | |
---|---|
XWikiDocumentArchive()
default constructor. |
|
XWikiDocumentArchive(long id)
|
Method Summary | |
---|---|
XWikiDocumentArchive |
clone(long docId,
XWikiContext context)
|
protected org.suigeneris.jrcs.rcs.Version |
createNextVersion(org.suigeneris.jrcs.rcs.Version cur,
boolean isMinor)
|
String |
getArchive(XWikiContext context)
|
Set<XWikiRCSNodeInfo> |
getDeletedNodeInfo()
|
long |
getId()
|
XWikiRCSNodeInfo |
getLatestNode()
|
org.suigeneris.jrcs.rcs.Version |
getLatestVersion()
|
org.suigeneris.jrcs.rcs.Version |
getNearestFullVersion(org.suigeneris.jrcs.rcs.Version ver)
|
org.suigeneris.jrcs.rcs.Version |
getNextVersion(org.suigeneris.jrcs.rcs.Version ver)
|
XWikiRCSNodeInfo |
getNode(org.suigeneris.jrcs.rcs.Version version)
|
Collection<XWikiRCSNodeInfo> |
getNodes()
|
Collection<XWikiRCSNodeInfo> |
getNodes(org.suigeneris.jrcs.rcs.Version vfrom,
org.suigeneris.jrcs.rcs.Version vto)
|
org.suigeneris.jrcs.rcs.Version |
getPrevVersion(org.suigeneris.jrcs.rcs.Version ver)
|
Set<XWikiRCSNodeContent> |
getUpdatedNodeContents()
|
Set<XWikiRCSNodeInfo> |
getUpdatedNodeInfos()
|
String |
getVersionXml(org.suigeneris.jrcs.rcs.Version version,
XWikiContext context)
Return the XML corresponding to a version. |
XWikiDocument |
loadDocument(org.suigeneris.jrcs.rcs.Version version,
XWikiContext context)
|
protected XWikiRCSNodeContent |
makePatch(XWikiRCSNodeInfo newnode,
XWikiDocument doc,
XWikiContext context)
Make a patch. |
void |
removeVersions(org.suigeneris.jrcs.rcs.Version newerVersion,
org.suigeneris.jrcs.rcs.Version olderVersion,
XWikiContext context)
Remove document versions from vfrom to vto, inclusive. |
void |
resetArchive()
reset history. |
void |
setArchive(String text)
Deserialize class. |
void |
setId(long id)
|
void |
setNodes(Collection<XWikiRCSNodeInfo> versions)
|
void |
updateArchive(XWikiDocument doc,
String author,
Date date,
String comment,
org.suigeneris.jrcs.rcs.Version version,
XWikiContext context)
Update history with new document version. |
protected void |
updateNode(XWikiRCSNodeInfo node)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public XWikiDocumentArchive(long id)
id
- = XWikiDocument.getId()
public XWikiDocumentArchive()
Method Detail |
---|
protected org.suigeneris.jrcs.rcs.Version createNextVersion(org.suigeneris.jrcs.rcs.Version cur, boolean isMinor)
cur
- - current versionisMinor
- - is modification is minor
protected void updateNode(XWikiRCSNodeInfo node)
node
- - node added to versionToNode and fullNodesprotected XWikiRCSNodeContent makePatch(XWikiRCSNodeInfo newnode, XWikiDocument doc, XWikiContext context) throws XWikiException
newnode
- - new node informationdoc
- - document for that patch createdcontext
- - used for loading node contents and generating xml
XWikiException
- if exception while loading contentpublic long getId()
XWikiDocument.getId()
- primary keypublic void setId(long id)
id
- = XWikiDocument.getId()
public Collection<XWikiRCSNodeInfo> getNodes()
public Collection<XWikiRCSNodeInfo> getNodes(org.suigeneris.jrcs.rcs.Version vfrom, org.suigeneris.jrcs.rcs.Version vto)
vfrom
- - start versionvto
- - end version
public void setNodes(Collection<XWikiRCSNodeInfo> versions)
versions
- - collection of XWikiRCSNodeInfopublic String getArchive(XWikiContext context) throws XWikiException
context
- - used for load nodes content
PackagePlugin
.
XWikiException
- if any errorpublic void setArchive(String text) throws XWikiException
PackagePlugin
.
text
- - archive in JRCS format
XWikiException
- if parse errorpublic void updateArchive(XWikiDocument doc, String author, Date date, String comment, org.suigeneris.jrcs.rcs.Version version, XWikiContext context) throws XWikiException
doc
- - document for this versionauthor
- - author of versiondate
- - date of versioncomment
- - version commentversion
- - preferably document version in historycontext
- - used for loading nodes content
XWikiException
- in any errorpublic void removeVersions(org.suigeneris.jrcs.rcs.Version newerVersion, org.suigeneris.jrcs.rcs.Version olderVersion, XWikiContext context) throws XWikiException
newerVersion
- - start versionolderVersion
- - end versioncontext
- - used for loading nodes content
XWikiException
- if any errorpublic XWikiDocument loadDocument(org.suigeneris.jrcs.rcs.Version version, XWikiContext context) throws XWikiException
version
- - which version to loadcontext
- - used for loading
XWikiException
- if any errorpublic String getVersionXml(org.suigeneris.jrcs.rcs.Version version, XWikiContext context) throws XWikiException
version
- The version to retrieve.context
- The context
.
XWikiException
- If any exception occured.public XWikiRCSNodeInfo getNode(org.suigeneris.jrcs.rcs.Version version)
version
- which version to get
XWikiRCSNodeInfo
by version. null if none.public org.suigeneris.jrcs.rcs.Version getLatestVersion()
public XWikiRCSNodeInfo getLatestNode()
public org.suigeneris.jrcs.rcs.Version getNextVersion(org.suigeneris.jrcs.rcs.Version ver)
ver
- - current version
public org.suigeneris.jrcs.rcs.Version getPrevVersion(org.suigeneris.jrcs.rcs.Version ver)
ver
- - current version
public org.suigeneris.jrcs.rcs.Version getNearestFullVersion(org.suigeneris.jrcs.rcs.Version ver)
ver
- - for what version find nearest
public void resetArchive()
public Set<XWikiRCSNodeInfo> getDeletedNodeInfo()
XWikiRCSNodeInfo
which are need for deletepublic Set<XWikiRCSNodeInfo> getUpdatedNodeInfos()
XWikiRCSNodeInfo
which are need for saveOrUpdatepublic Set<XWikiRCSNodeContent> getUpdatedNodeContents()
XWikiRCSNodeContent
which are need for updatepublic XWikiDocumentArchive clone(long docId, XWikiContext context) throws XWikiException
docId
- - new getId()
context
- - used for loading content
XWikiException
- if any error
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |