| java.lang.Object org.apache.lenya.cms.publication.DocumentLocator
DocumentLocator | public class DocumentLocator (Code) | | A DocumentLocator describes a document based on its path in the site structure. The actual
document doesn't have to exist.
|
Method Summary | |
public boolean | equals(Object obj) | public String | getArea() | public DocumentLocator | getAreaVersion(String area) Returns a locator with the same publication ID, path, and language, but with a different
area.
Parameters: area - The area. | public DocumentLocator | getChild(String step) Returns a child of this locator.
Parameters: step - The relative path to the child, it must not contain a slash. | public DocumentLocator | getDescendant(String relativePath) Returns a descendant of this locator.
Parameters: relativePath - The relative path which must not begin with a slash and must not beempty. | final protected static String | getKey(String pubId, String area, String path, String language) | protected String | getKey() | public String | getLanguage() | public DocumentLocator | getLanguageVersion(String language) Returns a locator with the same publication ID, area, and path, but with a different
language.
Parameters: language - The language. | public static DocumentLocator | getLocator(String pubId, String area, String path, String language) Returns a specific document locator.
Parameters: pubId - The publication ID. Parameters: area - The area of the document. Parameters: path - The path of the document in the site structure. Parameters: language - The language of the document. | public DocumentLocator | getParent() Returns the parent of this locator. | public DocumentLocator | getParent(String defaultPath) Returns the parent of this locator.
Parameters: defaultPath - The path of the locator to return if this is the root locator. | public String | getPath() | public DocumentLocator | getPathVersion(String path) Returns a locator with the same publication ID, area, and language, but a different path in
the site structure.
Parameters: path - The path. | public String | getPublicationId() | public int | hashCode() | public String | toString() |
getArea | public String getArea()(Code) | | The area of the document. |
getAreaVersion | public DocumentLocator getAreaVersion(String area)(Code) | | Returns a locator with the same publication ID, path, and language, but with a different
area.
Parameters: area - The area. A document locator. |
getChild | public DocumentLocator getChild(String step)(Code) | | Returns a child of this locator.
Parameters: step - The relative path to the child, it must not contain a slash. A document locator. |
getDescendant | public DocumentLocator getDescendant(String relativePath)(Code) | | Returns a descendant of this locator.
Parameters: relativePath - The relative path which must not begin with a slash and must not beempty. A document locator. |
getLanguage | public String getLanguage()(Code) | | The language of the document. |
getLanguageVersion | public DocumentLocator getLanguageVersion(String language)(Code) | | Returns a locator with the same publication ID, area, and path, but with a different
language.
Parameters: language - The language. A document locator. |
getLocator | public static DocumentLocator getLocator(String pubId, String area, String path, String language)(Code) | | Returns a specific document locator.
Parameters: pubId - The publication ID. Parameters: area - The area of the document. Parameters: path - The path of the document in the site structure. Parameters: language - The language of the document. A document locator. |
getParent | public DocumentLocator getParent()(Code) | | Returns the parent of this locator.
A document locator or null if this is the root locator. |
getParent | public DocumentLocator getParent(String defaultPath)(Code) | | Returns the parent of this locator.
Parameters: defaultPath - The path of the locator to return if this is the root locator. A document locator. |
getPath | public String getPath()(Code) | | The path of the document in the site structure. |
getPathVersion | public DocumentLocator getPathVersion(String path)(Code) | | Returns a locator with the same publication ID, area, and language, but a different path in
the site structure.
Parameters: path - The path. A document locator. |
getPublicationId | public String getPublicationId()(Code) | | The publication ID. |
hashCode | public int hashCode()(Code) | | |
|
|