Class DocumentRenderingContext
java.lang.Object
org.apache.maven.doxia.siterenderer.DocumentRenderingContext
The rendering context of a document.
If not rendered from a Doxia markup source, parserId and extension will be null.
- Since:
- 1.5 (was since 1.1 in o.a.m.d.sink.render)
- Author:
- Jason van Zyl
-
Constructor Summary
ConstructorsConstructorDescriptionDocumentRenderingContext
(File basedir, String document, String generator) Constructor for rendering context when document is not rendered from a Doxia markup source.DocumentRenderingContext
(File basedir, String basedirRelativePath, String document, String parserId, String extension, boolean editable) DocumentRenderingContext
(File basedir, String basedirRelativePath, String document, String parserId, String extension, boolean editable, String generator) Constructor for document rendering context. -
Method Summary
Modifier and TypeMethodDescriptiongetAttribute
(String key) getAttribute.Getter for the fieldbasedir
.Get the relative path of basedir (when a Doxia source)Get the relative path to Doxia source from build root.getDoxiaSourcePath
(String base) Get url of the Doxia source calculate from given base url.Get the source document filename extension (when a Doxia source)What is the generator (if any)?Deprecated.Method name does not properly reflect its purpose.Getter for the fieldinputPath
.Deprecated.Method name does not properly reflect its purpose.Get html output path, relative to site root.Get the parserId when document comes from a Doxia source.Get the relative path to site root.boolean
Is the document rendered from a Doxia source?boolean
Is the source document editable?void
setAttribute
(String key, String value) setAttribute.
-
Constructor Details
-
DocumentRenderingContext
Constructor for rendering context when document is not rendered from a Doxia markup source.
- Parameters:
basedir
- the pseudo-source base directory.document
- the pseudo-source document path: will be used to compute output path (same path with extension replaced with.html
).generator
- the generator (in general a reporting goal:groupId:artifactId:version:goal
)- Since:
- 1.8
-
DocumentRenderingContext
-
DocumentRenderingContext
public DocumentRenderingContext(File basedir, String basedirRelativePath, String document, String parserId, String extension, boolean editable, String generator) Constructor for document rendering context.
- Parameters:
basedir
- the source base directory (not null, pseudo value when not a Doxia source).basedirRelativePath
- the relative path from root (null if not Doxia source)document
- the source document path.parserId
- the Doxia module parser id associated to this document, may be null if document not rendered from a Doxia source.extension
- the source document filename extension, may be null if document not rendered from a Doxia source.editable
- is the document editable as source, i.e. not generated?generator
- the generator (in general a reporting goal:groupId:artifactId:version:goal
)- Since:
- 1.8
-
-
Method Details
-
getBasedir
Getter for the field
basedir
.- Returns:
- a
File
object.
-
getInputPath
Getter for the field
inputPath
.- Returns:
- a
String
object.
-
getInputName
Deprecated.Method name does not properly reflect its purpose. UsegetInputPath()
instead. -
getOutputPath
Get html output path, relative to site root.- Returns:
- html output path
- See Also:
-
getOutputName
Deprecated.Method name does not properly reflect its purpose. UsegetOutputPath()
instead. -
getParserId
Get the parserId when document comes from a Doxia source.- Returns:
- parser id, or
null
if not froma DOxia source.
-
getRelativePath
Get the relative path to site root.- Returns:
- the relative path to site root
-
setAttribute
setAttribute.
-
getAttribute
getAttribute.
-
getExtension
Get the source document filename extension (when a Doxia source)- Returns:
- the source document filename extension when a Doxia source, or
null
if not a Doxia source
-
isEditable
public boolean isEditable()Is the source document editable?- Returns:
true
if comes from an editable Doxia source (not generated one).- Since:
- 1.8
-
isDoxiaSource
public boolean isDoxiaSource()Is the document rendered from a Doxia source?- Returns:
true
if comes from a Doxia source.- Since:
- 1.8
-
getGenerator
What is the generator (if any)?- Returns:
null
if no known generator- Since:
- 1.8
-
getBasedirRelativePath
Get the relative path of basedir (when a Doxia source)- Returns:
- the relative path of basedir when a Doxia source, or
null
if not a Doxia source - Since:
- 1.8
-
getDoxiaSourcePath
Get the relative path to Doxia source from build root.- Returns:
- the relative path to Doxia source from build root, or
null
if not a Doxia source - Since:
- 1.8
-
getDoxiaSourcePath
Get url of the Doxia source calculate from given base url.- Parameters:
base
- the base url to use- Returns:
- the resulting url
- Since:
- 1.8
-