Java Doc for Document.java in » Content-Management-System » apache-lenya-2.0 » org » apache » lenya » cms » publication » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Content Management System » apache lenya 2.0 » org.apache.lenya.cms.publication

Source Cross Reference Class Diagram Java Document (Java Doc)

org.apache.lenya.cms.publication .Document

All known Subclasses:   org.apache.lenya.cms.publication .DocumentImpl,
Document
public interface Document extends MetaDataOwner,RepositoryItem(Code)
A CMS document.
version:
   $Id: Document.java 586495 2007-10-19 15:13:36Z rfrovarp $

Field Summary
String DEFAULT_PREFIX
     The default namespace prefix.
final String DOCUMENT_META_SUFFIX

String NAMESPACE
     The document namespace URI.
String TRANSACTIONABLE_TYPE
     The transactionable type for document objects.

Method Summary
void accept(DocumentVisitor visitor)
     Accepts a document visitor.
Area area()

void delete()
     Deletes the document.
boolean exists()
     Check if a document with the given document-uuid, language and in the given area actually exists.
boolean existsAreaVersion(String area)
     Checks if this document exists in a certain area.
Parameters:
  area - The area.
boolean existsInAnyLanguage()
     Check if a document exists with the given document-uuid and the given area independently of the given language.
boolean existsTranslation(String language)
     Checks if a certain translation (language version) of this document exists.
Parameters:
  language - The language.
boolean existsVersion(String area, String language)
     Checks if a translation of this document exists in a certain area.
Parameters:
  area - The area.
Parameters:
  language - The language.
String getArea()
     Returns the area this document belongs to.
Document getAreaVersion(String area)
     Returns the document in a certain area.
Parameters:
  area - The area.
String getCanonicalDocumentURL()
     Returns the canonical document URL.
String getCanonicalWebappURL()
     Returns the canonical web application URL.
long getContentLength()

Date getExpires()

String getExtension()
     Returns the extension in the URL without the dot.
DocumentFactory getFactory()
     Returns the identity map this document belongs to.
File getFile()
     Returns the file for this document.
DocumentIdentifier getIdentifier()

InputStream getInputStream()

String getLanguage()
     Returns the language of this document. Each document has one language associated to it.
String[] getLanguages()
     Returns all the languages this document is available in. A document has one associated language (@see Document#getLanguage) but there are possibly a number of other languages for which a document with the same document-uuid is also available in.
long getLastModified()
     Returns the date of the last modification of this document.
Link getLink()

DocumentLocator getLocator()

String getMimeType()

String getName()
     Returns the document name of this document.
OutputStream getOutputStream()

String getPath()
     This is a shortcut to getLink().getNode().getPath().
Publication getPublication()
     Returns the publication this document belongs to.
Node getRepositoryNode()

ResourceType getResourceType()

int getRevisionNumber()

String getSourceExtension()

String getSourceURI()
     Returns the URI to resolve the document's source.
Document getTranslation(String language)
     Returns a certain translation (language version) of this document.
Parameters:
  language - The language.
String getUUID()
     Returns the UUID.
Document getVersion(String area, String language)
     Returns a translation of this document in a certain area.
Parameters:
  area - The area.
Parameters:
  language - The language.
boolean hasLink()

void setMimeType(String mimeType)
     Sets the mime type of this document.
void setResourceType(ResourceType resourceType)

void setSourceExtension(String extension)


Field Detail
DEFAULT_PREFIX
String DEFAULT_PREFIX(Code)
The default namespace prefix.

DOCUMENT_META_SUFFIX
final String DOCUMENT_META_SUFFIX(Code)
DOCUMENT_META_SUFFIX The suffix for document meta Uris

NAMESPACE
String NAMESPACE(Code)
The document namespace URI.

TRANSACTIONABLE_TYPE
String TRANSACTIONABLE_TYPE(Code)
The transactionable type for document objects.

Method Detail
accept
void accept(DocumentVisitor visitor) throws PublicationException(Code)
Accepts a document visitor.
Parameters:
  visitor - The visitor.
throws:
  PublicationException - if an error occurs.

area
Area area()(Code)
The area the document belongs to.

delete
void delete() throws DocumentException(Code)
Deletes the document.
throws:
  DocumentException - if an error occurs.

exists
boolean exists() throws DocumentException(Code)
Check if a document with the given document-uuid, language and in the given area actually exists. true if the document exists, false otherwise
throws:
  DocumentException - if an error occurs

existsAreaVersion
boolean existsAreaVersion(String area)(Code)
Checks if this document exists in a certain area.
Parameters:
  area - The area. A boolean value.

existsInAnyLanguage
boolean existsInAnyLanguage() throws DocumentException(Code)
Check if a document exists with the given document-uuid and the given area independently of the given language. true if a document with the given document-uuid and area exists, false otherwise
throws:
  DocumentException - if an error occurs

existsTranslation
boolean existsTranslation(String language)(Code)
Checks if a certain translation (language version) of this document exists.
Parameters:
  language - The language. A boolean value.

existsVersion
boolean existsVersion(String area, String language)(Code)
Checks if a translation of this document exists in a certain area.
Parameters:
  area - The area.
Parameters:
  language - The language. A boolean value.

getArea
String getArea()(Code)
Returns the area this document belongs to. The area.

getAreaVersion
Document getAreaVersion(String area) throws DocumentException(Code)
Returns the document in a certain area.
Parameters:
  area - The area. A document.
throws:
  DocumentException - if the area version doesn't exist.

getCanonicalDocumentURL
String getCanonicalDocumentURL()(Code)
Returns the canonical document URL. A string.

getCanonicalWebappURL
String getCanonicalWebappURL()(Code)
Returns the canonical web application URL. A string.

getContentLength
long getContentLength() throws DocumentException(Code)
The content length of the document.
throws:
  DocumentException - if an error occurs.

getExpires
Date getExpires() throws DocumentException(Code)
Returns the date at which point the requested document is considered expired a string in RFC 1123 date format
throws:
  DocumentException - if an error occurs.

getExtension
String getExtension()(Code)
Returns the extension in the URL without the dot. A string.

getFactory
DocumentFactory getFactory()(Code)
Returns the identity map this document belongs to. A document identity map.

getFile
File getFile()(Code)
Returns the file for this document. A file object.Document.getSourceURI()

getIdentifier
DocumentIdentifier getIdentifier()(Code)
The document identifier for this document.

getInputStream
InputStream getInputStream()(Code)
The input stream to obtain the document's content.

getLanguage
String getLanguage()(Code)
Returns the language of this document. Each document has one language associated to it. A string denoting the language.

getLanguages
String[] getLanguages() throws DocumentException(Code)
Returns all the languages this document is available in. A document has one associated language (@see Document#getLanguage) but there are possibly a number of other languages for which a document with the same document-uuid is also available in. An array of strings denoting the languages.
throws:
  DocumentException - if an error occurs

getLastModified
long getLastModified() throws DocumentException(Code)
Returns the date of the last modification of this document. A date denoting the date of the last modification.
throws:
  DocumentException - if an error occurs.

getLink
Link getLink() throws DocumentException(Code)
The link to this document in the site structure.
throws:
  DocumentException - if the document is not referenced in the site structure.

getLocator
DocumentLocator getLocator()(Code)
A document locator.

getMimeType
String getMimeType() throws DocumentException(Code)
The mime type of this document.
throws:
  DocumentException - if an error occurs.

getName
String getName()(Code)
Returns the document name of this document. the document-name of this document.

getOutputStream
OutputStream getOutputStream()(Code)
The output stream to write the document content to.

getPath
String getPath() throws DocumentException(Code)
This is a shortcut to getLink().getNode().getPath(). The path of this document in the site structure.
throws:
  DocumentException - if the document is not linked in the site structure.

getPublication
Publication getPublication()(Code)
Returns the publication this document belongs to. A publication object.

getRepositoryNode
Node getRepositoryNode()(Code)
The repository node that represents this document.

getResourceType
ResourceType getResourceType() throws DocumentException(Code)
The resource type of this document (formerly known as doctype)
throws:
  DocumentException - if an error occurs.

getRevisionNumber
int getRevisionNumber()(Code)
The revision number of this document.

getSourceExtension
String getSourceExtension()(Code)
The source extension used by this document, without the dot.

getSourceURI
String getSourceURI()(Code)
Returns the URI to resolve the document's source. The source can only be used for read-only access. For write access, use Document.getOutputStream() . A string.

getTranslation
Document getTranslation(String language) throws DocumentException(Code)
Returns a certain translation (language version) of this document.
Parameters:
  language - The language. A document.
throws:
  DocumentException - if the language version doesn't exist.

getUUID
String getUUID()(Code)
Returns the UUID. A string.

getVersion
Document getVersion(String area, String language) throws DocumentException(Code)
Returns a translation of this document in a certain area.
Parameters:
  area - The area.
Parameters:
  language - The language. A document.
throws:
  DocumentException - if the area version doesn't exist.

hasLink
boolean hasLink()(Code)
if the document is linked in the site structure.

setMimeType
void setMimeType(String mimeType) throws DocumentException(Code)
Sets the mime type of this document.
Parameters:
  mimeType - The mime type.
throws:
  DocumentException - if an error occurs.

setResourceType
void setResourceType(ResourceType resourceType)(Code)

Parameters:
  resourceType - The resource type of this document.

setSourceExtension
void setSourceExtension(String extension)(Code)

Parameters:
  extension - The source extension used by this document, without the dot.

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.