org.apache.lenya.cms.publication
Interface DocumentIdToPathMapper

All Known Implementing Classes:

DefaultDocumentIdToPathMapper, IdentityDocumentIdToPathMapper, SingleLanguageIdentityMapper

public interface DocumentIdToPathMapper

Method Summary

java.io.File	getDirectory(Publication publication, java.lang.String area, java.lang.String documentId) Deprecated. replaced by getDirectory with access to the language Compute the document-path for a given publication, area and document-id. As there are possibly multiple files for the same document-id (for different languages) the return value is a directory.
java.io.File	getDirectory(Publication publication, java.lang.String area, java.lang.String documentId, java.lang.String language) Compute the document-path for a given publication, area and document-id.
java.io.File	getFile(Publication publication, java.lang.String area, java.lang.String documentId, java.lang.String language) Compute the document-path for a given publication, area, document-id and language
java.lang.String	getPath(java.lang.String documentId, java.lang.String language) Compute the document-path for a given publication, area and document-id.

Method Detail

getPath

java.lang.String getPath(java.lang.String documentId,
                         java.lang.String language)

Compute the document-path for a given publication, area and document-id. The file separator is the slash (/).

Parameters:

documentId - the document-id of the document

language - the language of the document

Returns:

the path to the document, without publication ID and area

getFile

java.io.File getFile(Publication publication,
                     java.lang.String area,
                     java.lang.String documentId,
                     java.lang.String language)

Compute the document-path for a given publication, area, document-id and language

Parameters:

publication - the publication of the document

area - the area of the document

documentId - the document-id of the document

language - the language of the document

Returns:

the path to the document

getDirectory

java.io.File getDirectory(Publication publication,
                          java.lang.String area,
                          java.lang.String documentId,
                          java.lang.String language)

Compute the document-path for a given publication, area and document-id. As there are possibly multiple files for the same document-id (for different languages) the return value is a directory.

Parameters:

publication - The publication.

area - The area.

documentId - The document id.

language - The language of the document.

Returns:

The directory where all the files with the same document-id are located

getDirectory

java.io.File getDirectory(Publication publication,
                          java.lang.String area,
                          java.lang.String documentId)

Deprecated. replaced by getDirectory with access to the language Compute the document-path for a given publication, area and document-id. As there are possibly multiple files for the same document-id (for different languages) the return value is a directory.

Parameters:

publication - The publication.

area - The area.

documentId - The document id.

Returns:

The directory where all the files with the same document-id are located