B C E G H I L N O R S T U V W

B

BaseTransform - Class in org.carewebframework.maven.plugin.help.chm

Extracts the topic tree from a view, converting from window-1252 to UTF-8 encoding and restructuring to create a more easily parsed format.

BaseTransform(BaseMojo, String) - Constructor for class org.carewebframework.maven.plugin.help.chm.BaseTransform

BinaryTransform - Class in org.carewebframework.maven.plugin.help.chm

Base transform for accessing structured data from a binary source.

BinaryTransform(BaseMojo, String) - Constructor for class org.carewebframework.maven.plugin.help.chm.BinaryTransform

C

ChmSource - Class in org.carewebframework.maven.plugin.help.chm

Used where source archive is a chm file format.

ChmSource(String) - Constructor for class org.carewebframework.maven.plugin.help.chm.ChmSource

Wraps a chm file as an IResourceIterator.

ChmSource.ChmEntry - Class in org.carewebframework.maven.plugin.help.chm

Wraps a DirectoryListingEntry as an IResource.

ChmSourceLoader - Class in org.carewebframework.maven.plugin.help.chm

Used where source archive is a chm file format.

ChmSourceLoader() - Constructor for class org.carewebframework.maven.plugin.help.chm.ChmSourceLoader

close() - Method in class org.carewebframework.maven.plugin.help.chm.ChmSource

compareTo(ChmSource.ChmEntry) - Method in class org.carewebframework.maven.plugin.help.chm.ChmSource.ChmEntry

CS_UTF8 - Static variable in class org.carewebframework.maven.plugin.help.chm.BaseTransform

CS_WIN1252 - Static variable in class org.carewebframework.maven.plugin.help.chm.BaseTransform

E

equals(Object) - Method in class org.carewebframework.maven.plugin.help.chm.ChmSource.ChmEntry

execute() - Method in class org.carewebframework.maven.plugin.help.HelpConverterMojo

Main execution entry point for plug-in.

extractAttribute(String, String) - Method in class org.carewebframework.maven.plugin.help.chm.BaseTransform

Extracts the value of the named attribute.

G

getFormatSpecifier() - Method in class org.carewebframework.maven.plugin.help.SourceLoader

getHelpSetFile() - Method in class org.carewebframework.maven.plugin.help.HelpProcessor

Returns the path to the main help set file, or null if one was not found during processing.

getHelpSetPattern() - Method in class org.carewebframework.maven.plugin.help.SourceLoader

getInputStream() - Method in class org.carewebframework.maven.plugin.help.chm.ChmSource.ChmEntry

getInputStream(String) - Method in class org.carewebframework.maven.plugin.help.chm.ChmSource.ChmEntry

Retrieves an input stream for a companion resource.

getIteratorClass() - Method in class org.carewebframework.maven.plugin.help.SourceLoader

Returns the class that will be used to iterate over the contents of a source archive.

getModuleBase() - Method in class org.carewebframework.maven.plugin.help.HelpConverterMojo

getModuleId() - Method in class org.carewebframework.maven.plugin.help.HelpConverterMojo

getModuleLocale() - Method in class org.carewebframework.maven.plugin.help.HelpConverterMojo

getModuleName() - Method in class org.carewebframework.maven.plugin.help.HelpConverterMojo

getResourceBase() - Method in class org.carewebframework.maven.plugin.help.HelpProcessor

getSourcePath() - Method in class org.carewebframework.maven.plugin.help.chm.ChmSource.ChmEntry

getString(byte[]) - Method in class org.carewebframework.maven.plugin.help.chm.BinaryTransform

Returns a string value from a zero-terminated byte array.

getString(byte[], int) - Method in class org.carewebframework.maven.plugin.help.chm.BinaryTransform

Returns a string value from a zero-terminated byte array at the specified offset.

getString(byte[], int, int) - Method in class org.carewebframework.maven.plugin.help.chm.BinaryTransform

Returns a string value from the byte array.

getTargetPath(IResource) - Method in class org.carewebframework.maven.plugin.help.chm.BaseTransform

Renames the source files.

getTargetPath() - Method in class org.carewebframework.maven.plugin.help.chm.ChmSource.ChmEntry

Need to explicitly translate #SYSTEM target here so that the Spring configuration file is generated correctly.

getTime() - Method in class org.carewebframework.maven.plugin.help.chm.ChmSource.ChmEntry

H

hasNext() - Method in class org.carewebframework.maven.plugin.help.chm.ChmSource

HelpConverterMojo - Class in org.carewebframework.maven.plugin.help

Goal which prepares a Help module in native format for repackaging into a CareWeb-compliant help module.

HelpConverterMojo() - Constructor for class org.carewebframework.maven.plugin.help.HelpConverterMojo

HelpProcessor - Class in org.carewebframework.maven.plugin.help

Processor for help content.

HelpProcessor(HelpConverterMojo, String, SourceLoader) - Constructor for class org.carewebframework.maven.plugin.help.HelpProcessor

HtmlTransform - Class in org.carewebframework.maven.plugin.help.chm

Transforms HTML pages by converting them from window-1252 encoding to UTF-8 and removing the character set metadata declaration.

HtmlTransform(BaseMojo) - Constructor for class org.carewebframework.maven.plugin.help.chm.HtmlTransform

I

isDirectory() - Method in class org.carewebframework.maven.plugin.help.chm.ChmSource.ChmEntry

isHelpSetFile(String) - Method in class org.carewebframework.maven.plugin.help.SourceLoader

Returns true if the file name matches the pattern specified for the main help set file.

L

load(String) - Method in class org.carewebframework.maven.plugin.help.SourceLoader

Returns a resource iterator instance for the given archive name.

loadBinaryFile(String) - Method in class org.carewebframework.maven.plugin.help.chm.BinaryTransform

Loads the entire contents of a binary file into a byte array.

N

next() - Method in class org.carewebframework.maven.plugin.help.chm.ChmSource

O

org.carewebframework.maven.plugin.help - package org.carewebframework.maven.plugin.help

org.carewebframework.maven.plugin.help.chm - package org.carewebframework.maven.plugin.help.chm

R

readDWord(InputStream) - Method in class org.carewebframework.maven.plugin.help.chm.BinaryTransform

Reads a four-byte integer from the input stream.

readDWord(byte[], int) - Method in class org.carewebframework.maven.plugin.help.chm.BinaryTransform

Reads a four-byte integer from a byte array at the specified offset.

readWord(InputStream) - Method in class org.carewebframework.maven.plugin.help.chm.BinaryTransform

Reads a two-byte integer from the input stream.

readWord(byte[], int) - Method in class org.carewebframework.maven.plugin.help.chm.BinaryTransform

Reads a two-byte integer from a byte array at the specified offset.

registerTransforms(HelpProcessor) - Method in class org.carewebframework.maven.plugin.help.chm.ChmSourceLoader

registerTransforms(HelpProcessor) - Method in class org.carewebframework.maven.plugin.help.SourceLoader

Register all file transforms with the main processor.

relocateResource(String) - Method in class org.carewebframework.maven.plugin.help.HelpProcessor

remove() - Method in class org.carewebframework.maven.plugin.help.chm.ChmSource

S

SourceLoader - Class in org.carewebframework.maven.plugin.help

Generic source loader.

SourceLoader(String, String, Class<? extends IResourceIterator>) - Constructor for class org.carewebframework.maven.plugin.help.SourceLoader

Create a source loader.

SystemTransform - Class in org.carewebframework.maven.plugin.help.chm

Transforms settings extracted from the #SYSTEM file to a standard properties file.

SystemTransform(BaseMojo) - Constructor for class org.carewebframework.maven.plugin.help.chm.SystemTransform

T

TopicTransform - Class in org.carewebframework.maven.plugin.help.chm

Transforms #TOPICS file to XML format.

TopicTransform(BaseMojo) - Constructor for class org.carewebframework.maven.plugin.help.chm.TopicTransform

transform(IResource, OutputStream) - Method in class org.carewebframework.maven.plugin.help.chm.BaseTransform

transform(IResource, OutputStream) - Method in class org.carewebframework.maven.plugin.help.chm.BinaryTransform

transform(InputStream, OutputStream) - Method in class org.carewebframework.maven.plugin.help.chm.HtmlTransform

transform(InputStream, OutputStream) - Method in class org.carewebframework.maven.plugin.help.chm.SystemTransform

transform(InputStream, OutputStream) - Method in class org.carewebframework.maven.plugin.help.chm.TopicTransform

transform(InputStream, OutputStream) - Method in class org.carewebframework.maven.plugin.help.chm.ViewTransform

Transforms the input to well-formed XML.

transform() - Method in class org.carewebframework.maven.plugin.help.HelpProcessor

transform(IResource) - Method in class org.carewebframework.maven.plugin.help.HelpProcessor

Excludes resources under the META-INF folder and checks the resource against the help set pattern, saving a path reference if it matches.

type - Variable in class org.carewebframework.maven.plugin.help.chm.BaseTransform

U

UTF8 - Static variable in class org.carewebframework.maven.plugin.help.chm.BaseTransform

V

ViewTransform - Class in org.carewebframework.maven.plugin.help.chm

Extracts the topic tree from a view, converting from window-1252 to UTF-8 encoding and restructuring to create a more easily parsed format.

ViewTransform(BaseMojo, String) - Constructor for class org.carewebframework.maven.plugin.help.chm.ViewTransform

W

WIN1252 - Static variable in class org.carewebframework.maven.plugin.help.chm.BaseTransform

write(OutputStream, String) - Method in class org.carewebframework.maven.plugin.help.chm.BaseTransform

Write data to the output stream without any special formatting.

write(OutputStream, String, boolean, int) - Method in class org.carewebframework.maven.plugin.help.chm.BaseTransform

Write data to the output stream with the specified formatting.

writeAttribute(OutputStream, String, String) - Method in class org.carewebframework.maven.plugin.help.chm.BaseTransform

Write the attribute's name/value pair to the output stream.

writeSetting(OutputStream, String, Object, int) - Method in class org.carewebframework.maven.plugin.help.chm.BaseTransform

Writes a setting's name/value pair to the output stream.

B C E G H I L N O R S T U V W