A B C D E F G H I M N P R S T W

A

AbstractTransformerMojo - Class in com.agilejava.docbkx.maven

The abstract Mojo base for concrete Mojos that generate some kind of output format from DocBook.

AbstractTransformerMojo() - Constructor for class com.agilejava.docbkx.maven.AbstractTransformerMojo

adjustTransformer(Transformer, String, File) - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

The operation to override when it is required to make some adjustments to the Transformer right before it is applied to a certain source file.

B

build() - Method in class com.agilejava.docbkx.maven.CachingTransformerBuilder

DOCUMENT ME!

build() - Method in interface com.agilejava.docbkx.maven.TransformerBuilder

Builds a Transformer.

C

CachingTransformerBuilder - Class in com.agilejava.docbkx.maven

A caching TransformerBuilder, holding on to the Transformer it created.

CachingTransformerBuilder(TransformerBuilder) - Constructor for class com.agilejava.docbkx.maven.CachingTransformerBuilder

Constructs a new instance.

catalogs - Variable in class com.agilejava.docbkx.maven.AbstractTransformerMojo

close() - Method in class com.agilejava.docbkx.maven.NullWriter

DOCUMENT ME!

com.agilejava.docbkx.maven - package com.agilejava.docbkx.maven

configure(Transformer) - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

Configure the Transformer by passing in some parameters.

configureXref(File) - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

convertBooleanToXsltParam(String) - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

Converts a Boolean parameter to the type expected by the XSLT processor.

convertStringToXsltParam(String) - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

Converts a String parameter to the type expected by the XSLT processor.

createCatalogManager() - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

Creates a CatalogManager, used to resolve DTDs and other entities.

createDocumentBuilder() - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

Creates a DocumentBuilder to be used to parse DocBook XML documents.

createSource(String, File, PreprocessingFilter) - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

Creates a SAXSource configured with the desired XInclude mode.

createTitleXPath() - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

Creates an instance of an XPath expression for picking the title from a document.

createTransformerBuilder(URIResolver) - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

Constructs the default TransformerBuilder.

createTree(Properties) - Static method in class com.agilejava.docbkx.maven.ExpressionUtils

DOCUMENT ME!

D

dumpResolvedXML(String, Document) - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

Saves the Docbook XML file with all XInclude resolved.

E

Entity - Class in com.agilejava.docbkx.maven

The representation of an entity, consisting of a name and a value.

Entity() - Constructor for class com.agilejava.docbkx.maven.Entity

execute() - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

Builds the actual output document.

executeTasks(Target, MavenProject) - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

Configures and executes the given ant tasks, mainly preprocess and postprocess defined in the pom configuration.

ExpressionHandler - Class in com.agilejava.docbkx.maven

A ProcessingInstructionHandler that evaluates expressions passed as data as JSP expression language expressions.

ExpressionHandler(VariableResolver, Log) - Constructor for class com.agilejava.docbkx.maven.ExpressionHandler

Constructs a new instance.

ExpressionUtils - Class in com.agilejava.docbkx.maven

DOCUMENT ME!

ExpressionUtils() - Constructor for class com.agilejava.docbkx.maven.ExpressionUtils

F

flush() - Method in class com.agilejava.docbkx.maven.NullWriter

DOCUMENT ME!

forceInjection() - Method in class com.agilejava.docbkx.maven.InjectingEntityResolver

Forces the object to inject the entities.

G

getArtifacts() - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

Returns the plugin dependencies.

getByteStream() - Method in class com.agilejava.docbkx.maven.InjectingEntityResolver.ReplacementInputSource

getCharacterStream() - Method in class com.agilejava.docbkx.maven.InjectingEntityResolver.ReplacementInputSource

getCustomizationParameters() - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

A list of additional XSL parameters to give to the XSLT engine.

getDefaultStylesheetLocation() - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

Returns the default stylesheet location within the root of the stylesheet distribution.

getDefaultStylesheetURL() - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

Returns the URL of the default stylesheet.

getEncoding() - Method in class com.agilejava.docbkx.maven.InjectingEntityResolver.ReplacementInputSource

getEntities() - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

Returns a list of Entities

getGeneratedSourceDirectory() - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

Returns the directory to use to save the resolved docbook XML before it is given to the Transformer.

getHandlers() - Method in class com.agilejava.docbkx.maven.PreprocessingFilter

Returns the list of handlers.

getIncludes() - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

Returns the include patterns, as a comma-seperate collection of patterns.

getMavenProject() - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

Returns a reference to the current project.

getName() - Method in class com.agilejava.docbkx.maven.Entity

Returns the name of the entity.

getName() - Method in class com.agilejava.docbkx.maven.Parameter

Returns the name of the parameter.

getNonDefaultStylesheetLocation() - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

The stylesheet location override by a class in the mojo hierarchy.

getNonDefaultStylesheetURL() - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

Returns the URL of the default stylesheet.

getPostProcess() - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

Returns the tasks that should be executed after the transformation.

getPreProcess() - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

Returns the tasks that should be executed before the transformation.

getProperty(String) - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

Returns the value of a property of this object using introspection.

getPublicId() - Method in class com.agilejava.docbkx.maven.InjectingEntityResolver.ReplacementInputSource

getSourceDirectory() - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

Returns the source directory containing the source XML files.

getStylesheetLocation() - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

Returns the actual stylesheet location.

getStylesheetURL() - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

Returns the URL of the stylesheet.

getSystemId() - Method in class com.agilejava.docbkx.maven.InjectingEntityResolver.ReplacementInputSource

getSystemProperties() - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

Returns the additional System Properties.

getTargetDirectory() - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

Returns the target directory in which all results should be placed.

getTargetFileExtension() - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

Returns the extension of the target files, e.g.

getType() - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

Returns the type of conversion.

getValue() - Method in class com.agilejava.docbkx.maven.Entity

Returns the value of the entity.

getValue() - Method in class com.agilejava.docbkx.maven.Parameter

Returns the value of the parameter.

getXIncludeSupported() - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

Returns a boolean indicating if XInclude should be supported.

H

handle(String, ContentHandler) - Method in class com.agilejava.docbkx.maven.ExpressionHandler

DOCUMENT ME!

handle(String, ContentHandler) - Method in interface com.agilejava.docbkx.maven.ProcessingInstructionHandler

Handles the processing instruction, optionally using the handler to replace content.

I

InjectingEntityResolver - Class in com.agilejava.docbkx.maven

An EntityResolver that will inject a couple of additional general internal entities into the DTD resolved by underlying resolver.

InjectingEntityResolver(List, EntityResolver, String, Log) - Constructor for class com.agilejava.docbkx.maven.InjectingEntityResolver

Creates a new InjectingEntityResolver object.

InjectingEntityResolver.ReplacementInputSource - Class in com.agilejava.docbkx.maven

The InputSource that will replace the first InputSource retrieved, containig XML entity declarations for all entities defined in the POM.

InjectingEntityResolver.ReplacementInputSource(String) - Constructor for class com.agilejava.docbkx.maven.InjectingEntityResolver.ReplacementInputSource

isShowXslMessages() - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

Returns true if the xslt engine have to print xsl:messages to standard output.

isSkip() - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

isUseStandardOutput() - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

Returns false if the stylesheet is responsible to create the output file(s) using its own naming scheme.

M

matches(String) - Method in class com.agilejava.docbkx.maven.ExpressionHandler

DOCUMENT ME!

matches(String) - Method in interface com.agilejava.docbkx.maven.ProcessingInstructionHandler

Returns a boolean indicating if this filter is interested in handling the processing instruction.

N

NullWriter - Class in com.agilejava.docbkx.maven

DOCUMENT ME!

NullWriter() - Constructor for class com.agilejava.docbkx.maven.NullWriter

P

Parameter - Class in com.agilejava.docbkx.maven

The representation of an XSL parameter made of a name and a value.

Parameter() - Constructor for class com.agilejava.docbkx.maven.Parameter

postProcess() - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

Allows classes to add their own specific post-processing logic.

postProcessResult(File) - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

Post-processes the file.

preProcess() - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

Allows subclasses to add their own specific pre-processing logic.

PreprocessingFilter - Class in com.agilejava.docbkx.maven

A XMLFilter managing a collection of ProcessingInstructionHandlers, using them to handle processing instructions encountered while parsing the XML document.

PreprocessingFilter(XMLReader) - Constructor for class com.agilejava.docbkx.maven.PreprocessingFilter

Constructs a new instance.

processingInstruction(String, String) - Method in class com.agilejava.docbkx.maven.PreprocessingFilter

DOCUMENT ME!

ProcessingInstructionHandler - Interface in com.agilejava.docbkx.maven

The interface to be implemented by objects that are able to deal with processing instructions.

R

resolve(String, String) - Method in class com.agilejava.docbkx.maven.StylesheetResolver

DOCUMENT ME!

resolveEntity(String, String) - Method in class com.agilejava.docbkx.maven.InjectingEntityResolver

Returns the InputSource containing the external entity's data.

S

setByteStream(InputStream) - Method in class com.agilejava.docbkx.maven.InjectingEntityResolver.ReplacementInputSource

setCharacterStream(Reader) - Method in class com.agilejava.docbkx.maven.InjectingEntityResolver.ReplacementInputSource

setEncoding(String) - Method in class com.agilejava.docbkx.maven.InjectingEntityResolver.ReplacementInputSource

setHandlers(List) - Method in class com.agilejava.docbkx.maven.PreprocessingFilter

Sets the list of handlers.

setName(String) - Method in class com.agilejava.docbkx.maven.Entity

Sets the name of the entity.

setName(String) - Method in class com.agilejava.docbkx.maven.Parameter

Sets the name of the parameter.

setProperty(String, String) - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

Sets the value of a property of this object using introspection.

setPublicId(String) - Method in class com.agilejava.docbkx.maven.InjectingEntityResolver.ReplacementInputSource

setShowXslMessages(boolean) - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

setSystemId(String) - Method in class com.agilejava.docbkx.maven.InjectingEntityResolver.ReplacementInputSource

setTargetFileExtension(String) - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

Sets the file extension, this can be usefull to override this value especially for multiple transformations plugins (like XML to FO to PDF).

setUseStandardOutput(boolean) - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

setValue(String) - Method in class com.agilejava.docbkx.maven.Entity

Sets the value of the entity.

setValue(String) - Method in class com.agilejava.docbkx.maven.Parameter

Sets the value of the parameter.

shouldProcessResult() - Method in class com.agilejava.docbkx.maven.AbstractTransformerMojo

Tells if the stylesheet generate any main outputs, if not the chain of processing will be stopped.

StylesheetResolver - Class in com.agilejava.docbkx.maven

A simple URIResolver decorator that will bail out of the normal way of retrieving entities as soon as the publicId or systemId matches a given URN.

StylesheetResolver(String, Source, URIResolver) - Constructor for class com.agilejava.docbkx.maven.StylesheetResolver

Creates a new StylesheetResolver object.

T

TransformerBuilder - Interface in com.agilejava.docbkx.maven

An object creating a Transformer.

TransformerBuilder.TransformerBuilderException - Exception in com.agilejava.docbkx.maven

The exception thrown when the TransformerBuilder will not be able to reproduce the Transformer.

TransformerBuilder.TransformerBuilderException(String, Throwable) - Constructor for exception com.agilejava.docbkx.maven.TransformerBuilder.TransformerBuilderException

W

write(char[], int, int) - Method in class com.agilejava.docbkx.maven.NullWriter

DOCUMENT ME!

A B C D E F G H I M N P R S T W