This project has retired. For details please refer to its Attic page.

org.apache.lenya.cms.publication.file
Class FilePublication

java.lang.Object
  org.apache.lenya.cms.publication.AbstractPublication
      org.apache.lenya.cms.publication.file.FilePublication

All Implemented Interfaces:

Publication

public class FilePublication
extends AbstractPublication

A file-based publication.

Field Summary

Fields inherited from interface org.apache.lenya.cms.publication.Publication

ADMIN_AREA, ARCHIVE_AREA, ATTRIBUTE_TYPE, AUTHORING_AREA, BREADCRUMB_PREFIX, CONFIGURATION_FILE, CONFIGURATION_PATH, CONTENT_PATH, DEFAULT_LANGUAGE_ATTR, DELETE_PATH, ELEMENT_DOCUMENT_BUILDER, ELEMENT_PATH_MAPPER, ELEMENT_SITE_STRUCTURE, INFO_AREA_PREFIX, LANGUAGE, LANGUAGES, LIVE_AREA, LIVE_MOUNT_POINT, PENDING_PATH, PUBLICATION_PREFIX, PUBLICATION_PREFIX_URI, SEARCH_AREA_PREFIX, SSL_PREFIX, STAGING_AREA, TRASH_AREA

Constructor Summary

FilePublication(java.lang.String id, java.lang.String servletContextPath)
Ctor.

Method Summary

void	copyDocumentSetToArea(DocumentSet documentSet, java.lang.String destinationArea) Copies a document set to another area.
void	copyDocumentSource(Document sourceDocument, Document destinationDocument) Copies a document source.
void	copyDocumentToArea(Document document, java.lang.String destinationArea) Copies a document to another area.
protected void	deleteDocumentSource(Document document) Deletes the source of a document.
protected java.io.File	getAreaDirectory(java.lang.String area) Returns the directory where documents of a certain area are located.

Methods inherited from class org.apache.lenya.cms.publication.AbstractPublication

copyDocument, copySiteStructure, deleteDocument, deleteFromSiteStructure, equals, getAreaVersion, getBreadcrumbPrefix, getContentDirectory, getContentDirKey, getDefaultLanguage, getDirectory, getDocumentBuilder, getEnvironment, getId, getLanguages, getLiveMountPoint, getPathMapper, getProxy, getProxyKey, getRewriteAttributeXPaths, getServletContext, getSiteTree, getSSLPrefix, getTree, hashCode, isValidArea, moveDocument, setDefaultLanguage, setPathMapper

Methods inherited from class java.lang.Object

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

Constructor Detail

FilePublication

public FilePublication(java.lang.String id,
                       java.lang.String servletContextPath)
                throws PublicationException

Ctor.

Parameters:

id - The publication ID.

servletContextPath - The servlet context path.

Throws:

PublicationException - when something went wrong.

Method Detail

getAreaDirectory

protected java.io.File getAreaDirectory(java.lang.String area)

Returns the directory where documents of a certain area are located.

Parameters:

area -

Returns:

copyDocumentToArea

public void copyDocumentToArea(Document document,
                               java.lang.String destinationArea)
                        throws PublicationException

Description copied from interface: Publication

Copies a document to another area.

Parameters:

document - The document to copy.

destinationArea - The destination area.

Throws:

PublicationException - if a document which the destination document depends on does not exist.

See Also:

Publication.copyDocumentToArea(org.apache.lenya.cms.publication.Document, java.lang.String)

copyDocumentSource

public void copyDocumentSource(Document sourceDocument,
                               Document destinationDocument)
                        throws PublicationException

Description copied from class: AbstractPublication

Copies a document source.

Specified by:

copyDocumentSource in class AbstractPublication

Parameters:

sourceDocument - The source document.

destinationDocument - The destination document.

Throws:

PublicationException - when something went wrong.

See Also:

AbstractPublication.copyDocumentSource(org.apache.lenya.cms.publication.Document, org.apache.lenya.cms.publication.Document)

copyDocumentSetToArea

public void copyDocumentSetToArea(DocumentSet documentSet,
                                  java.lang.String destinationArea)
                           throws PublicationException

Description copied from interface: Publication

Copies a document set to another area.

Parameters:

documentSet - The document set to copy.

destinationArea - The destination area.

Throws:

PublicationException - if a document which one of the destination documents depends on does not exist.

See Also:

Publication.copyDocumentSetToArea(org.apache.lenya.cms.publication.DocumentSet, java.lang.String)

deleteDocumentSource

protected void deleteDocumentSource(Document document)
                             throws PublicationException

Description copied from class: AbstractPublication

Deletes the source of a document.

Specified by:

deleteDocumentSource in class AbstractPublication

Parameters:

document - The document to delete.

Throws:

PublicationException - when something went wrong.

See Also:

AbstractPublication.deleteDocumentSource(org.apache.lenya.cms.publication.Document)