|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.lenya.cms.publication.PageEnvelope
public class PageEnvelope
A page envelope carries a set of information that are needed during the presentation of a document.
Field Summary | |
---|---|
static java.lang.String |
AREA
|
static java.lang.String |
BREADCRUMB_PREFIX
|
static java.lang.String |
CONTEXT
|
static java.lang.String |
DEFAULT_LANGUAGE
|
static java.lang.String |
DEFAULT_PREFIX
|
static java.lang.String |
DOCUMENT
|
static java.lang.String |
DOCUMENT_DC_CREATOR
Deprecated. Use Document.getDublinCore() instead |
static java.lang.String |
DOCUMENT_DC_DATE_CREATED
Deprecated. Use Document.getDublinCore() instead |
static java.lang.String |
DOCUMENT_DC_DESCRIPTION
Deprecated. Use Document.getDublinCore() instead |
static java.lang.String |
DOCUMENT_DC_PUBLISHER
Deprecated. Use Document.getDublinCore() instead |
static java.lang.String |
DOCUMENT_DC_RIGHTS
Deprecated. Use Document.getDublinCore() instead |
static java.lang.String |
DOCUMENT_DC_SUBJECT
Deprecated. Use Document.getDublinCore() instead |
static java.lang.String |
DOCUMENT_DC_TITLE
Deprecated. Use Document.getDublinCore() instead |
static java.lang.String |
DOCUMENT_EXTENSION
|
static java.lang.String |
DOCUMENT_FILE
|
static java.lang.String |
DOCUMENT_ID
|
static java.lang.String |
DOCUMENT_LABEL
|
static java.lang.String |
DOCUMENT_LANGUAGE
|
static java.lang.String |
DOCUMENT_LANGUAGES
|
static java.lang.String |
DOCUMENT_LANGUAGES_CSV
|
static java.lang.String |
DOCUMENT_LASTMODIFIED
|
static java.lang.String |
DOCUMENT_NAME
|
static java.lang.String |
DOCUMENT_NODE_ID
|
static java.lang.String |
DOCUMENT_PATH
|
static java.lang.String |
DOCUMENT_TYPE
|
static java.lang.String |
DOCUMENT_URL
|
static java.lang.String |
DOCUMENT_URL_WITHOUT_LANGUAGE
|
static java.lang.String |
NAMESPACE
|
static java.lang.String[] |
PARAMETER_NAMES
The names of the page envelope parameters. |
static java.lang.String |
PUBLICATION
|
static java.lang.String |
PUBLICATION_ID
|
static java.lang.String |
PUBLICATION_LANGUAGES_CSV
|
static java.lang.String |
SSL_PREFIX
|
Constructor Summary | |
---|---|
protected |
PageEnvelope()
Constructor. |
|
PageEnvelope(java.util.Map objectModel)
Deprecated. Performance problems. Use PageEnvelopeFactory.getPageEnvelope(Map)
instead. |
protected |
PageEnvelope(java.util.Map objectModel,
boolean createdByFactory)
Creates a page envelope from an object model. |
|
PageEnvelope(Publication publication,
org.apache.cocoon.environment.Request request)
Deprecated. Performance problems. Use PageEnvelopeFactory.getPageEnvelope(Map)
instead. |
|
PageEnvelope(Publication publication,
org.apache.cocoon.environment.Request request,
boolean createdByFactory)
Creates a new instance of PageEnvelope from a sitemap inside a publication. |
Method Summary | |
---|---|
protected java.lang.String |
createExceptionMessage(org.apache.cocoon.environment.Request request)
Creates the message to report when creating the envelope failed. |
java.lang.String |
getContext()
Returns the context, e.g. |
Document |
getDocument()
Returns the document. |
java.lang.String |
getDocumentPath()
Returns the document-path. |
Publication |
getPublication()
Returns the publication of this PageEnvelope. |
RCEnvironment |
getRCEnvironment()
Deprecated. We should detach the RC environment from the page envelope. |
protected void |
init(Publication publication,
org.apache.cocoon.environment.Request request)
Setup an instance of Publication. |
protected void |
setContext(java.lang.String string)
|
void |
setDocument(Document document)
Sets the document. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String PUBLICATION_ID
public static final java.lang.String PUBLICATION
public static final java.lang.String PUBLICATION_LANGUAGES_CSV
public static final java.lang.String CONTEXT
public static final java.lang.String AREA
public static final java.lang.String DEFAULT_LANGUAGE
public static final java.lang.String DOCUMENT
public static final java.lang.String DOCUMENT_ID
public static final java.lang.String DOCUMENT_NAME
public static final java.lang.String DOCUMENT_TYPE
public static final java.lang.String DOCUMENT_NODE_ID
public static final java.lang.String DOCUMENT_LABEL
public static final java.lang.String DOCUMENT_URL
public static final java.lang.String DOCUMENT_URL_WITHOUT_LANGUAGE
public static final java.lang.String DOCUMENT_FILE
public static final java.lang.String DOCUMENT_PATH
public static final java.lang.String DOCUMENT_EXTENSION
public static final java.lang.String DOCUMENT_LANGUAGE
public static final java.lang.String DOCUMENT_LANGUAGES
public static final java.lang.String DOCUMENT_LANGUAGES_CSV
public static final java.lang.String DOCUMENT_DC_TITLE
Document.getDublinCore()
insteadpublic static final java.lang.String DOCUMENT_DC_CREATOR
Document.getDublinCore()
insteadpublic static final java.lang.String DOCUMENT_DC_SUBJECT
Document.getDublinCore()
insteadpublic static final java.lang.String DOCUMENT_DC_PUBLISHER
Document.getDublinCore()
insteadpublic static final java.lang.String DOCUMENT_DC_DATE_CREATED
Document.getDublinCore()
insteadpublic static final java.lang.String DOCUMENT_DC_DESCRIPTION
Document.getDublinCore()
insteadpublic static final java.lang.String DOCUMENT_DC_RIGHTS
Document.getDublinCore()
insteadpublic static final java.lang.String DOCUMENT_LASTMODIFIED
public static final java.lang.String BREADCRUMB_PREFIX
public static final java.lang.String SSL_PREFIX
public static final java.lang.String NAMESPACE
public static final java.lang.String DEFAULT_PREFIX
public static final java.lang.String[] PARAMETER_NAMES
Constructor Detail |
---|
protected PageEnvelope()
public PageEnvelope(Publication publication, org.apache.cocoon.environment.Request request) throws PageEnvelopeException
PageEnvelopeFactory.getPageEnvelope(Map)
instead.
publication
- The publication the page belongs to.request
- The request that calls the page.
PageEnvelopeException
- if an error occurspublic PageEnvelope(java.util.Map objectModel) throws PageEnvelopeException
PageEnvelopeFactory.getPageEnvelope(Map)
instead.
objectModel
- The object model.
PageEnvelopeException
- when something went wrong.public PageEnvelope(Publication publication, org.apache.cocoon.environment.Request request, boolean createdByFactory) throws PageEnvelopeException
publication
- The publication the page belongs to.request
- The request that calls the page.createdByFactory
- A dummy parameter to allow creating an additional protected constructor that is
not deprecated.
PageEnvelopeException
- if an error occursprotected PageEnvelope(java.util.Map objectModel, boolean createdByFactory) throws PageEnvelopeException
objectModel
- The object model.createdByFactory
- A dummy parameter to allow creating an additional protected constructor that is
not deprecated.
PageEnvelopeException
- when something went wrong.Method Detail |
---|
protected void init(Publication publication, org.apache.cocoon.environment.Request request) throws PageEnvelopeException
publication
- The publication the page belongs to.request
- The request that calls the page.
PageEnvelopeException
- if an error occurs.protected java.lang.String createExceptionMessage(org.apache.cocoon.environment.Request request)
request
- The request.
public Publication getPublication()
Publication
valuepublic RCEnvironment getRCEnvironment()
RCEnvironment
valuepublic java.lang.String getContext()
String
valuepublic java.lang.String getDocumentPath()
File value
protected void setContext(java.lang.String string)
string
- The context.public Document getDocument()
public void setDocument(Document document)
document
- A document.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |