DocumentRenderingContext (Doxia Sitetools :: Site Renderer 2.0.0 API)

java.lang.Object
- org.apache.maven.doxia.siterenderer.DocumentRenderingContext

```
public class DocumentRenderingContext
extends Object
```
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

Constructors
Constructor and Description
`DocumentRenderingContext(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

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`getAttribute(String key)` getAttribute.
`File`	`getBasedir()` Getter for the field `basedir`.
`String`	`getBasedirRelativePath()` Get the relative path of basedir (when a Doxia source)
`String`	`getDoxiaSourcePath()` Get the relative path to Doxia source from build root.
`String`	`getDoxiaSourcePath(String base)` Get url of the Doxia source calculate from given base url.
`String`	`getExtension()` Get the source document filename extension (when a Doxia source)
`String`	`getGenerator()` What is the generator (if any)?
`String`	`getInputName()` Deprecated. Method name does not properly reflect its purpose. Use `getInputPath()` instead.
`String`	`getInputPath()` Getter for the field `inputPath`.
`String`	`getOutputName()` Deprecated. Method name does not properly reflect its purpose. Use `getOutputPath()` instead.
`String`	`getOutputPath()` Get html output path, relative to site root.
`String`	`getParserId()` Get the parserId when document comes from a Doxia source.
`String`	`getRelativePath()` Get the relative path to site root.
`boolean`	`isDoxiaSource()` Is the document rendered from a Doxia source?
`boolean`	`isEditable()` Is the source document editable?
`void`	`setAttribute(String key, String value)` setAttribute.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DocumentRenderingContext
```
public DocumentRenderingContext(File basedir,
                                String document,
                                String generator)
```
    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
```
public DocumentRenderingContext(File basedir,
                                String basedirRelativePath,
                                String document,
                                String parserId,
                                String extension,
                                boolean editable)
```
  - 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 Detail
  - getBasedir
```
public File getBasedir()
```
    Getter for the field basedir.
    
    Returns:
    
    a File object.
  - getInputPath
```
public String getInputPath()
```
    Getter for the field inputPath.
    
    Returns:
    
    a String object.
  - getInputName
```
@Deprecated
public String getInputName()
```
    Deprecated. Method name does not properly reflect its purpose. Use getInputPath() instead.
  - getOutputPath
```
public String getOutputPath()
```
    Get html output path, relative to site root.
    
    Returns:
    
    html output path
    
    See Also:
    
    PathTool.getRelativePath(String)
  - getOutputName
```
@Deprecated
public String getOutputName()
```
    Deprecated. Method name does not properly reflect its purpose. Use getOutputPath() instead.
  - getParserId
```
public String getParserId()
```
    Get the parserId when document comes from a Doxia source.
    
    Returns:
    
    parser id, or null if not froma DOxia source.
  - getRelativePath
```
public String getRelativePath()
```
    Get the relative path to site root.
    
    Returns:
    
    the relative path to site root
  - setAttribute
```
public void setAttribute(String key,
                         String value)
```
    setAttribute.
    
    Parameters:
    
    key - a String object.
    
    value - a String object.
  - getAttribute
```
public String getAttribute(String key)
```
    getAttribute.
    
    Parameters:
    
    key - a String object.
    
    Returns:
    
    a String object.
  - getExtension
```
public String 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
```
public String getGenerator()
```
    What is the generator (if any)?
    
    Returns:
    
    null if no known generator
    
    Since:
    
    1.8
  - getBasedirRelativePath
```
public String 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
```
public String 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
```
public String getDoxiaSourcePath(String base)
```
    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

Class DocumentRenderingContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocumentRenderingContext

DocumentRenderingContext

DocumentRenderingContext

Method Detail

getBasedir

getInputPath

getInputName

getOutputPath

getOutputName

getParserId

getRelativePath

setAttribute

getAttribute

getExtension

isEditable

isDoxiaSource

getGenerator

getBasedirRelativePath

getDoxiaSourcePath

getDoxiaSourcePath