A B C D E F G H I J L M N O P Q R S T U V W X

A

ABOVE_AT_MASK - Static variable in class org.writersforge.catalan.layout.Relation
Vertically above the attractor, at exactly distance
ABOVE_MASK - Static variable in class org.writersforge.catalan.layout.Relation
Vertically above the attractor, with no comparison operator specified
ABOVE_MAX_MASK - Static variable in class org.writersforge.catalan.layout.Relation
Vertically above the attractor, no further than distance
ABOVE_MIN_MASK - Static variable in class org.writersforge.catalan.layout.Relation
Vertically above the attractor, no closer than distance
ALIGN_BOTTOM - Static variable in interface org.writersforge.catalan.layout.style.AlignStyle
Text should be aligned to the bottom
ALIGN_CENTER - Static variable in interface org.writersforge.catalan.layout.style.AlignStyle
Text should be aligned to the center
ALIGN_ENUM - Static variable in interface org.writersforge.catalan.layout.style.AlignStyle
Enumeration of text alignment
ALIGN_LEFT - Static variable in interface org.writersforge.catalan.layout.style.AlignStyle
Text should be aligned to the left
ALIGN_RIGHT - Static variable in interface org.writersforge.catalan.layout.style.AlignStyle
Text should be aligned to the right
ALIGN_TOP - Static variable in interface org.writersforge.catalan.layout.style.AlignStyle
Text should be aligned to the top
ASCII_ENGINE - Static variable in class org.writersforge.catalan.layout.LayoutFactory
The factory name for the AsciiLayout engine.
AbstractLayoutEngine - class org.writersforge.catalan.layout.AbstractLayoutEngine.
 
AbstractLayoutEngine() - Constructor for class org.writersforge.catalan.layout.AbstractLayoutEngine
 
Alert - class org.writersforge.catalan.process.queue.Alert.
A message returned from the transform processing.
Alert(AlertPriority, String) - Constructor for class org.writersforge.catalan.process.queue.Alert
Creates a new instance of Alert with a text message.
Alert(AlertPriority, Exception) - Constructor for class org.writersforge.catalan.process.queue.Alert
Creates a new instance of Alert with an exception.
Alert(AlertPriority, String, Exception) - Constructor for class org.writersforge.catalan.process.queue.Alert
Creates a new instance of Alert with a text message and an exception.
AlertPriority - class org.writersforge.catalan.process.queue.AlertPriority.
An enumeration of Alert severities.
AlertQueue - class org.writersforge.catalan.process.queue.AlertQueue.
Manager for all alerts generated during a processing run.
AlertQueue() - Constructor for class org.writersforge.catalan.process.queue.AlertQueue
Creates a new instance of AlertQueue.
AlignStyle - interface org.writersforge.catalan.layout.style.AlignStyle.
The directional orientation of the given area.
AllStyle - interface org.writersforge.catalan.layout.style.AllStyle.
Composite style all known style interfaces.
AreaStyle - interface org.writersforge.catalan.layout.style.AreaStyle.
Composite style for layout area objects.
AsciiFieldManager - class org.writersforge.catalan.text.AsciiFieldManager.
A field-level manager for packing and unpacking ASCII data.
AsciiFieldManager(String) - Constructor for class org.writersforge.catalan.text.AsciiFieldManager
Creates a new instance of AsciiFieldManager.
AsciiLayout - class org.writersforge.catalan.layout.AsciiLayout.
Ascii art-style layout engine, a starting point for the TextRenderer
AsciiLayout() - Constructor for class org.writersforge.catalan.layout.AsciiLayout
 
acceptArea(LayoutArea) - Method in class org.writersforge.catalan.layout.AbstractLayoutEngine
Adds the area to the layout queue.
acceptArea(LayoutArea) - Method in class org.writersforge.catalan.layout.LayoutContext
Adds an area to the list of renderable areas for the current page.
acceptArea(LayoutArea) - Method in interface org.writersforge.catalan.layout.LayoutEngine
Adds the area to the layout queue.
acceptArea(LayoutArea, LayoutContext, List) - Method in class org.writersforge.catalan.layout.SimpleFlowLayout
Accept the entire contents of this area; if this is a group area, accept all child elements.
addAlert(Alert) - Method in class org.writersforge.catalan.process.queue.AlertQueue
Adds the alert to the queue.
addAllStyle(AllStyle) - Method in class org.writersforge.catalan.layout.style.StyleChain
Adds an AllStyle to the front of the lookup chain.
addArea(LayoutArea) - Method in class org.writersforge.catalan.layout.Page
Appends a new LayoutArea object into the Page.
addAreaStyle(AreaStyle) - Method in class org.writersforge.catalan.layout.style.StyleChain
Adds a AreaStyle to the front of the lookup chain.
addAreas(LayoutArea[]) - Method in class org.writersforge.catalan.layout.Page
Appends an array of LayoutArea objects into the Page.
addChildren(LayoutArea) - Method in class org.writersforge.catalan.layout.LayoutArea
Appends a new child LayoutArea object into this area.
addChildren(LayoutArea[]) - Method in class org.writersforge.catalan.layout.LayoutArea
Appends an array of child LayoutArea objects into this area.
addChildren(LayoutArea) - Method in class org.writersforge.catalan.layout.LayoutGroup
Appends a new child LayoutArea object into this area.
addChildren(LayoutArea[]) - Method in class org.writersforge.catalan.layout.LayoutGroup
Appends an array of child LayoutArea objects into this area.
addClassFilter(Class) - Method in class org.writersforge.catalan.process.queue.NodeSelection
Adds a constraint to select nodes of the given class or interface, or any derived classes.
addClassWorker(String, Class, IWorkProperties) - Method in class org.writersforge.catalan.process.workers.WorkerRegistry
Adds a newly instantiated IWorker of the given Class to the registry.
addConfiguredFileset(FileSet) - Method in class org.writersforge.catalan.util.TransformTask
Loads the files selected by the <fileset> element into the list of input nodes.
addConfiguredInput(TransformTask.Input) - Method in class org.writersforge.catalan.util.TransformTask
Loads the PCDATA contents of the next child element.
addConstraint(String) - Method in class org.writersforge.catalan.process.queue.NodeSelection
Adds the given selection constraint spec.
addCustomWorker(String, String, IWorkProperties) - Method in class org.writersforge.catalan.process.workers.WorkerRegistry
Adds a IWorker to the registry, derived from a IWorker that already exists in the registry.
addDirective(DirectiveStack.Directive) - Method in class org.writersforge.catalan.process.workers.xml.DirectiveStack
Adds a formatting Directive to the end of the stack.
addDirective(DirectiveStack.Directive) - Method in class org.writersforge.catalan.transform.xml.DirectiveStack
Adds a formatting Directive to the end of the stack.
addExclusion(String, String) - Method in class org.writersforge.catalan.transform.text.Normalizer
Adds an exclusion region, for example quoted data that should not be normalized.
addExternalWorker(String, IWorker, IWorkProperties) - Method in class org.writersforge.catalan.process.workers.WorkerRegistry
Adds an externally created IWorker to the registry.
addFallback(Datum) - Method in class org.writersforge.catalan.transform.ProcessorRegistry
Adds a registry map to the front of the registry.
addFontStyle(FontStyle) - Method in class org.writersforge.catalan.layout.style.StyleChain
Adds a FontStyle to the front of the lookup chain.
addIndex(int) - Method in class org.writersforge.catalan.process.queue.NodeSelection
Adds a constraint to select a single node by its zero-based index.
addLeftover(Object) - Method in class org.writersforge.catalan.transform.BaseNodeProcessor
Add a node to the list of unprocessed nodes.
addMarkup(FontStyle, int, int) - Method in class org.writersforge.catalan.layout.StyledText
Adds Style markup across a given range.
addOverride(Datum) - Method in class org.writersforge.catalan.transform.ProcessorRegistry
Adds a registry map to the front of the registry.
addPage(Page) - Method in class org.writersforge.catalan.layout.Book
Appends a new Page object into the Book.
addPropertySet(IWorkProperties) - Method in class org.writersforge.catalan.process.properties.ChainedProperties
Adds the given IWorkProperties object to the end of the chain.
addQueue(String, IQueue) - Method in class org.writersforge.catalan.process.queue.QueueManager
Adds a named queue.
addRange(int, int) - Method in class org.writersforge.catalan.process.queue.NodeSelection
Adds a constraint for a contiguous span of its zero-based indexes to select.
addRegexpFilter(String) - Method in class org.writersforge.catalan.process.queue.NodeSelection
Adds a constraint to select nodes that match the given regular expression.
addRelations(Relation) - Method in class org.writersforge.catalan.layout.Constraint
Appends a new Relation object into the Constraint.
addText(String) - Method in class org.writersforge.catalan.layout.StyledText
Appends the given text to the current text using the default style.
addText(String, FontStyle) - Method in class org.writersforge.catalan.layout.StyledText
Appends the given text to the current text using the given Style.
addText(String) - Method in class org.writersforge.catalan.util.TransformTask.Input
Assigns PCDATA element content.
addTextStyle(TextStyle) - Method in class org.writersforge.catalan.layout.style.StyleChain
Adds a TextStyle to the front of the lookup chain.
addToPage(Page, LayoutArea) - Method in class org.writersforge.catalan.layout.AsciiLayout
Attempts to add a single area to the Page.
addWorkersFromDatum(Datum) - Method in class org.writersforge.catalan.process.workers.XmlWorkerRegistry
Loads workers from any <workers> element inside the XML document.
addWorkersFromPath(String) - Method in class org.writersforge.catalan.process.workers.XmlWorkerRegistry
Loads workers from any <workers> element inside the XML document at the given path.
asFile() - Method in class org.writersforge.catalan.process.workers.io.IOAdapter
Converts the wrapped object into an File object.
asInputStream() - Method in class org.writersforge.catalan.process.workers.io.IOAdapter
Converts the wrapped object into an InputStream object.
asMap() - Method in class org.writersforge.catalan.process.properties.BaseWorkProperties
Adapts this property set into a Map instance.
asMap(IWorkProperties) - Static method in class org.writersforge.catalan.process.properties.BaseWorkProperties
Adapts a property set into a Map instance.
asOutputStream() - Method in class org.writersforge.catalan.process.workers.io.IOAdapter
Converts the wrapped object into an OutputStream object.
asOutputStream(boolean) - Method in class org.writersforge.catalan.process.workers.io.IOAdapter
Converts the wrapped object into an OutputStream object with appending preference.
asReader() - Method in class org.writersforge.catalan.process.workers.io.IOAdapter
Converts the wrapped object into a Reader object.
asWriter() - Method in class org.writersforge.catalan.process.workers.io.IOAdapter
Converts the wrapped object into a Writer object.
asWriter(boolean) - Method in class org.writersforge.catalan.process.workers.io.IOAdapter
Converts the wrapped object into a Writer object with appending preference.

B

BELOW_AT_MASK - Static variable in class org.writersforge.catalan.layout.Relation
Vertically below the attractor, at exactly distance
BELOW_MASK - Static variable in class org.writersforge.catalan.layout.Relation
Vertically below the attractor, at exactly distance
BELOW_MAX_MASK - Static variable in class org.writersforge.catalan.layout.Relation
Vertically below the attractor, no further than distance
BELOW_MIN_MASK - Static variable in class org.writersforge.catalan.layout.Relation
Vertically below the attractor, no closer than distance
BaseCommand - class org.writersforge.catalan.process.commands.BaseCommand.
Default implementation of ICommand.
BaseCommand(String, String) - Constructor for class org.writersforge.catalan.process.commands.BaseCommand
Creates a new instance of BaseCommand.
BaseCommand(String, String, PropertyInfo[], OptionalPropertyInfo[]) - Constructor for class org.writersforge.catalan.process.commands.BaseCommand
Creates a new instance of BaseCommand.
BaseCommandWorker - class org.writersforge.catalan.process.commands.BaseCommandWorker.
BaseWorker extension with support for the ICommand interface.
BaseCommandWorker() - Constructor for class org.writersforge.catalan.process.commands.BaseCommandWorker
 
BaseJob - class org.writersforge.catalan.process.workers.BaseJob.
Base implementation of BaseJob API.
BaseJob(IWorkMetadata) - Constructor for class org.writersforge.catalan.process.workers.BaseJob
Creates a new instance of BaseJob.
BaseMetadataHolder - class org.writersforge.catalan.process.workers.BaseMetadataHolder.
Minimal implementation of IWorker interface.
BaseMetadataHolder(String, String) - Constructor for class org.writersforge.catalan.process.workers.BaseMetadataHolder
Creates a new instance of BaseWorker with no property metadata.
BaseMetadataHolder(String, String, PropertyInfo[], OptionalPropertyInfo[]) - Constructor for class org.writersforge.catalan.process.workers.BaseMetadataHolder
Creates a new instance of BaseWorker with no property metadata.
BaseMetadataHolder(IWorkMetadata) - Constructor for class org.writersforge.catalan.process.workers.BaseMetadataHolder
Creates a new instance of BaseWorker with full metadata.
BaseNodeProcessor - class org.writersforge.catalan.transform.BaseNodeProcessor.
A common base implementation for NodeProcessor.
BaseNodeProcessor() - Constructor for class org.writersforge.catalan.transform.BaseNodeProcessor
Creates a new instance of BaseNodeProcessor.
BaseQueryCommand - class org.writersforge.catalan.process.workers.xml.BaseQueryCommand.
Shared class for XML commands that select XML content with a "query" property.
BaseQueryCommand(String, String) - Constructor for class org.writersforge.catalan.process.workers.xml.BaseQueryCommand
Creates a new instance of BaseQueryCommand.
BaseQueryCommand(String, String, PropertyInfo[], OptionalPropertyInfo[]) - Constructor for class org.writersforge.catalan.process.workers.xml.BaseQueryCommand
Creates a new instance of BaseQueryCommand.
BaseTextCommand - class org.writersforge.catalan.process.workers.text.BaseTextCommand.
Common base class for text commands, for sharing common methods.
BaseTextCommand(String, String) - Constructor for class org.writersforge.catalan.process.workers.text.BaseTextCommand
Creates a new instance of BaseTextCommand.
BaseTextCommand(String, String, PropertyInfo[], OptionalPropertyInfo[]) - Constructor for class org.writersforge.catalan.process.workers.text.BaseTextCommand
Creates a new instance of BaseTextCommand.
BaseWorkProperties - class org.writersforge.catalan.process.properties.BaseWorkProperties.
Base class helper for IWorkProperties implementations.
BaseWorkProperties() - Constructor for class org.writersforge.catalan.process.properties.BaseWorkProperties
 
BaseWorker - class org.writersforge.catalan.process.workers.BaseWorker.
Shared implementation of the IWorker interface.
BaseWorker() - Constructor for class org.writersforge.catalan.process.workers.BaseWorker
Creates a new instance of BaseWorker with default autogenerated metadata.
BaseWorker(IWorkMetadata) - Constructor for class org.writersforge.catalan.process.workers.BaseWorker
Creates a new instance of BaseWorker.
BaseWorkspace - class org.writersforge.catalan.process.workspace.BaseWorkspace.
Running data context for an entire processing run.
BaseWorkspace() - Constructor for class org.writersforge.catalan.process.workspace.BaseWorkspace
Creates a new instance of IWorkspace.
BeanToXml - class org.writersforge.catalan.transform.xml.BeanToXml.
A processor which converts each input node into an XML tree.
BeanToXml(Datum) - Constructor for class org.writersforge.catalan.transform.xml.BeanToXml
Creates a new instance of BeanToXml from the XML spec.
BeanToXml(boolean, PropertyName.PropertyStyle) - Constructor for class org.writersforge.catalan.transform.xml.BeanToXml
Creates a new instance of BeanToXml with the specified collapse and naming style.
BeanToXmlCommand - class org.writersforge.catalan.process.workers.javabean.BeanToXmlCommand.
Implementation of "bean-to-xml" command.
BeanToXmlCommand() - Constructor for class org.writersforge.catalan.process.workers.javabean.BeanToXmlCommand
Creates a new instance of BeanToXmlCommand.
Book - class org.writersforge.catalan.layout.Book.
A collection of Page objects, to be passed on to a Renderer.
Book(ListDatum) - Constructor for class org.writersforge.catalan.layout.Book
Creates a new instance of Book
BorderStyle - interface org.writersforge.catalan.layout.style.BorderStyle.
Hints on how to draw the outline border of an area.
BraceMatchSplitter - class org.writersforge.catalan.text.extractors.BraceMatchSplitter.
Text splitter which divides a text document according to matching pairs of open/close brace tokens.
BraceMatchSplitter() - Constructor for class org.writersforge.catalan.text.extractors.BraceMatchSplitter
Creates a new instance of BraceMatchSplitter.
BraceMatchSplitter(String, String) - Constructor for class org.writersforge.catalan.text.extractors.BraceMatchSplitter
Creates a new instance of BraceMatchSplitter with custom braces.
buildFlowLayout(Section, String, Book) - Method in class org.writersforge.catalan.templates.GenericTemplate
Renders a single flow region in the current section, using the data in the Book as an input source.
buildFlowLayout(Section, String, Book) - Method in class org.writersforge.catalan.templates.RenderTemplate
Renders a single flow region in the current section, using the data in the Book as an input source.
buildStaticLayout(Section, String, Book) - Method in class org.writersforge.catalan.templates.GenericTemplate
Renders a single static region in the current section, using the data in the Book as an input source.
buildStaticLayout(Section, String, Book) - Method in class org.writersforge.catalan.templates.RenderTemplate
Renders a single static region in the current section, using the data in the Book as an input source.

C

CaseFilter - class org.writersforge.catalan.text.filters.CaseFilter.
Text filter to alter the upper/lower capitalization style of a text document.
CaseFilter(CaseFilter.CaseStyle) - Constructor for class org.writersforge.catalan.text.filters.CaseFilter
Creates a new instance of CaseFilter.
CaseFilter.CaseStyle - class org.writersforge.catalan.text.filters.CaseFilter.CaseStyle.
Enumeration for upper/lower case capitalization styles.
CaseFilter.CaseStyle() - Constructor for class org.writersforge.catalan.text.filters.CaseFilter.CaseStyle
 
CatalanLogFormatter - class org.writersforge.catalan.util.CatalanLogFormatter.
Custom Java 1.4 logging formatter.
CatalanLogFormatter() - Constructor for class org.writersforge.catalan.util.CatalanLogFormatter
 
ChainedProperties - class org.writersforge.catalan.process.properties.ChainedProperties.
A IWorkProperties that merges more than one IWorkProperties object into a chain of configurations.
ChainedProperties() - Constructor for class org.writersforge.catalan.process.properties.ChainedProperties
Creates a new instance of ChainedProperties.
ChangeCaseCommand - class org.writersforge.catalan.process.workers.text.ChangeCaseCommand.
Implementation of "change-case" command.
ChangeCaseCommand() - Constructor for class org.writersforge.catalan.process.workers.text.ChangeCaseCommand
Creates a new instance of ChangeCaseCommand.
CodeGenerator - class org.writersforge.catalan.process.CodeGenerator.
Front end for Catalan code generation.
CodeGenerator(String[]) - Constructor for class org.writersforge.catalan.process.CodeGenerator
Creates a new instance of CodeGenerator.
CommandArgs - class org.writersforge.catalan.util.CommandArgs.
Utility class for managing command line arguments.
CommandArgs(String[]) - Constructor for class org.writersforge.catalan.util.CommandArgs
Creates a new instance of CommandArgs.
CommandContext - class org.writersforge.catalan.process.commands.CommandContext.
Encapsulates the set of parameters which should be passed to the ICommand.run() method.
CommandContext(IWorkProperties, IWorkspace) - Constructor for class org.writersforge.catalan.process.commands.CommandContext
Creates a new instance of CommandContext.
CommandContext(IWorkProperties, IWorkspace, List) - Constructor for class org.writersforge.catalan.process.commands.CommandContext
Creates a new instance of CommandContext with an active nodes set.
CommandOp - class org.writersforge.catalan.templates.generic.CommandOp.
Common base class for all template ops that represent processing commands.
CommandOp(Datum, StyleMap) - Constructor for class org.writersforge.catalan.templates.generic.CommandOp
Creates a new instance of CommandOp.
CommandOp(Datum, StyleMap, StyleChain) - Constructor for class org.writersforge.catalan.templates.generic.CommandOp
Creates a new instance of CommandOp with an optional StyleChain fallback.
CommonProperties - class org.writersforge.catalan.process.properties.CommonProperties.
IWorkProperties wrapper to add accessors for universally used properties.
CommonProperties(IWorkProperties) - Constructor for class org.writersforge.catalan.process.properties.CommonProperties
Creates a new instance of CommonProperties.
ConcatenateCommand - class org.writersforge.catalan.process.workers.text.ConcatenateCommand.
Implementation of "concat" command.
ConcatenateCommand() - Constructor for class org.writersforge.catalan.process.workers.text.ConcatenateCommand
Creates a new instance of ConcatenateCommand.
Concatenator - class org.writersforge.catalan.text.mergers.Concatenator.
Text merger which concatenates all fragments into a single document.
Concatenator() - Constructor for class org.writersforge.catalan.text.mergers.Concatenator
Creates a new instance of Concatenator.
Concatenator(String) - Constructor for class org.writersforge.catalan.text.mergers.Concatenator
Creates a new instance of Concatenator with a delimiter.
Concatenator - class org.writersforge.catalan.transform.text.Concatenator.
A processor which converts all input nodes into String formats and concatenates them into a single output String node.
Concatenator(Datum) - Constructor for class org.writersforge.catalan.transform.text.Concatenator
Creates a new instance of Concatenator from the XML spec.
Concatenator(int, String) - Constructor for class org.writersforge.catalan.transform.text.Concatenator
Creates a new instance of Concatenator with a maximum node count and a separator.
Constraint - class org.writersforge.catalan.layout.Constraint.
Geometrical constraints for a single LayoutArea object.
Constraint() - Constructor for class org.writersforge.catalan.layout.Constraint
Creates a new instance of Constraint.
Constraint(Dimension) - Constructor for class org.writersforge.catalan.layout.Constraint
Creates a new instance of Constraint.
Constraint(Dimension, boolean) - Constructor for class org.writersforge.catalan.layout.Constraint
Creates a new instance of Constraint.
Constraint(Dimension, Dimension, Dimension, boolean) - Constructor for class org.writersforge.catalan.layout.Constraint
Creates a new instance of Constraint.
ContentOp - class org.writersforge.catalan.templates.generic.ContentOp.
Common base class for all template ops that produce renderable content.
ContentOp(Datum, StyleMap) - Constructor for class org.writersforge.catalan.templates.generic.ContentOp
Creates a new instance of ContentOp.
ContentOp(Datum, StyleMap, StyleChain) - Constructor for class org.writersforge.catalan.templates.generic.ContentOp
Creates a new instance of ContentOp with an optional StyleChain fallback.
ControlWorker - class org.writersforge.catalan.process.workers.control.ControlWorker.
IWorker implementation which provides flow control and maintenance functions.
ControlWorker() - Constructor for class org.writersforge.catalan.process.workers.control.ControlWorker
 
CopyProcessor - class org.writersforge.catalan.transform.xform.CopyProcessor.
A Datum-only NodeProcessor for duplicating existing XML content to other parts of the same XML tree.
CopyProcessor(Datum) - Constructor for class org.writersforge.catalan.transform.xform.CopyProcessor
Creates a new instance of CopyProcessor from the XML spec.
CopyProcessor(String, String, String, int) - Constructor for class org.writersforge.catalan.transform.xform.CopyProcessor
Creates a new instance of CopyProcessor.
calculateFinalExtents(LayoutArea, LayoutContext) - Method in class org.writersforge.catalan.layout.SimpleFlowLayout
Creates an extent for placing the area in its final position in the layout.
calculatePartitionLength(String) - Method in class org.writersforge.catalan.process.workers.partition.Partition
Finds the length of this partition.
canBreakAt(int) - Method in class org.writersforge.catalan.layout.LayoutArea
Determines if this area can be broken at the given height, measured from the top of the area.
charWidth(char) - Method in class org.writersforge.catalan.layout.style.FontStyleMetrics
Estimates the width of the given character in this style.
clear() - Method in class org.writersforge.catalan.layout.StyledText
Removes all text and markup.
clearPages() - Method in class org.writersforge.catalan.layout.Book
Removes all current pages.
clearQueue() - Method in class org.writersforge.catalan.layout.AbstractLayoutEngine
Empties out the layout queue.
clearQueue() - Method in interface org.writersforge.catalan.layout.LayoutEngine
Empties out the layout queue.
clearSelection() - Method in class org.writersforge.catalan.process.queue.NodeSelection
Removes all current selection constraints.
convertBean(Object, PropertyName.PropertyStyle, boolean) - Method in class org.writersforge.catalan.process.workers.javabean.BeanToXmlCommand
Converts an arbitrary JavaBean object into a Bellows XML tree.
convertToArray(List) - Method in class org.writersforge.catalan.process.workers.text.BaseTextCommand
Loads String versions of all given nodes into a String array.
convertToXml(String) - Method in class org.writersforge.catalan.process.workers.text.TextToXmlCommand
Converts the given text into a Bellows XML tree.
convertXml(String, Datum) - Method in class org.writersforge.catalan.process.workers.javabean.XmlToBeanCommand
Loads an XML tree into a JavaBean object from a fully qualified class String.
convertXml(Class, Datum) - Method in class org.writersforge.catalan.process.workers.javabean.XmlToBeanCommand
Loads an XML tree into a JavaBean object from a Java Class.
copyNodes(String, String, int, NodeSelection) - Method in class org.writersforge.catalan.process.queue.QueueManager
Copies nodes from one IQueue to another.
createBorder(int, Color) - Static method in class org.writersforge.catalan.layout.LayoutShape
Creates a border shape area.
createNewPage(Book) - Method in class org.writersforge.catalan.templates.GenericTemplate
Creates a new Page object, initialized with width, height, and margins appropriate to this template and Book.
createNewPage(Book) - Method in class org.writersforge.catalan.templates.RenderTemplate
Creates a new Page object, initialized with width, height, and margins appropriate to this template and Book.
createOp(Datum, StyleMap) - Static method in class org.writersforge.catalan.templates.generic.GenericOp
Factory method for creating new ops.
createOp(Datum, StyleMap, StyleChain) - Static method in class org.writersforge.catalan.templates.generic.GenericOp
Factory method for creating new ops initialized with an optional StyleChain fallback.
createPadding(int, int) - Static method in class org.writersforge.catalan.layout.LayoutPadding
Creates a new instance of LayoutPadding with the given preferred size.
createPadding(int, int, int, int) - Static method in class org.writersforge.catalan.layout.LayoutPadding
Creates a new instance of LayoutPadding with the given preferred size.
createProcessor(Datum) - Method in class org.writersforge.catalan.transform.ProcessorRegistry
Instantiates a processor from the settings in the given Transform XML operation.

D

DEFAULT_STYLE - Static variable in class org.writersforge.catalan.layout.style.DefaultStyle
Sole public instance of DefaultStyle
DatumAdapter - class org.writersforge.catalan.process.workers.velocity.DatumAdapter.
Simple adapter for exporting both raw Datum tree and DatumQuery support for easy use in Velocity templates.
DatumAdapter(Datum) - Constructor for class org.writersforge.catalan.process.workers.velocity.DatumAdapter
Creates a new instance of DatumAdapter.
DatumAdapter - class org.writersforge.catalan.transform.external.DatumAdapter.
Simple adapter for exporting both raw Datum tree and DatumQuery support for easy use in Velocity templates.
DatumAdapter(Datum) - Constructor for class org.writersforge.catalan.transform.external.DatumAdapter
Creates a new instance of DatumAdapter.
DatumStyleMap - class org.writersforge.catalan.layout.style.DatumStyleMap.
StyleMap wrapper around a <style-map> Datum tree.
DatumStyleMap(Datum) - Constructor for class org.writersforge.catalan.layout.style.DatumStyleMap
Creates a new instance of DatumStyleMap.
DatumStyleWrapper - class org.writersforge.catalan.layout.style.DatumStyleWrapper.
Convenience wrapper that exports all known style interfaces from a single Datum object.
DatumStyleWrapper() - Constructor for class org.writersforge.catalan.layout.style.DatumStyleWrapper
Creates a new instance of DatumStyleWrapper with all default values.
DatumStyleWrapper(Datum) - Constructor for class org.writersforge.catalan.layout.style.DatumStyleWrapper
Creates a new instance of DatumStyleWrapper with given datum.
DatumStyleWrapper(Datum, boolean) - Constructor for class org.writersforge.catalan.layout.style.DatumStyleWrapper
Creates a new instance of DatumStyleWrapper with given datum, StyleMap, and inheritance flag.
DatumToObject - class org.writersforge.catalan.transform.xml.DatumToObject.
A text processor which converts Datum content into a List of java objects.
DatumToObject(Datum) - Constructor for class org.writersforge.catalan.transform.xml.DatumToObject
Creates a new instance of DatumToObject from the XML spec.
DatumToObject(ListDatum[]) - Constructor for class org.writersforge.catalan.transform.xml.DatumToObject
Creates a new instance of DatumToObject.
DebugProcessor - class org.writersforge.catalan.transform.io.DebugProcessor.
Debug logging processor which sends each node to the debug output, but does not alter anything.
DebugProcessor(Datum) - Constructor for class org.writersforge.catalan.transform.io.DebugProcessor
Creates a new instance of DebugProcessor from the XML spec.
DebugProcessor(String, String, String) - Constructor for class org.writersforge.catalan.transform.io.DebugProcessor
Creates a new instance of DebugProcessor that logs all nodes to the requested logging channel.
DebugProcessor(String, String) - Constructor for class org.writersforge.catalan.transform.io.DebugProcessor
Creates a new instance of DebugProcessor that logs the message to the requested logging channel.
DefaultNamedQueue - class org.writersforge.catalan.process.queue.DefaultNamedQueue.
A IQueue that holds named properties; an INamedQueue should wrap a Map collection.
DefaultNamedQueue() - Constructor for class org.writersforge.catalan.process.queue.DefaultNamedQueue
Creates a new empty instance of DefaultNamedQueue.
DefaultNamedQueue(Map, Map, boolean) - Constructor for class org.writersforge.catalan.process.queue.DefaultNamedQueue
Creates a new instance of DefaultNamedQueue initialized with the given parameters.
DefaultQueue - class org.writersforge.catalan.process.queue.DefaultQueue.
A collection of processing nodes.
DefaultQueue() - Constructor for class org.writersforge.catalan.process.queue.DefaultQueue
Creates a new instance of a writable DefaultQueue with no properties.
DefaultQueue(IQueue) - Constructor for class org.writersforge.catalan.process.queue.DefaultQueue
Creates a new instance as a copy of the given queue.
DefaultQueue(List) - Constructor for class org.writersforge.catalan.process.queue.DefaultQueue
Creates a new instance of a writable DefaultQueue with the queue nodes.
DefaultQueue(List, IWorkProperties, boolean) - Constructor for class org.writersforge.catalan.process.queue.DefaultQueue
Creates a new instance of DefaultQueue with a work property set.
DefaultStyle - class org.writersforge.catalan.layout.style.DefaultStyle.
An implementation of the FontStyle, TextStyle, and AreaStyle interfaces with all hardcoded defaults.
DefaultWorkerInfo - class org.writersforge.catalan.process.workers.DefaultWorkerInfo.
Default implementation of IWorkerInfo.
DefaultWorkerInfo(String, String) - Constructor for class org.writersforge.catalan.process.workers.DefaultWorkerInfo
Creates a new instance of DefaultWorkerInfo with no property metadata.
DefaultWorkerInfo(String, String, PropertyInfo[], OptionalPropertyInfo[]) - Constructor for class org.writersforge.catalan.process.workers.DefaultWorkerInfo
Creates a new instance of DefaultWorkerInfo with property metadata.
DefaultWorkerRegistry - class org.writersforge.catalan.process.workers.DefaultWorkerRegistry.
WorkerRegistry that pre-loads all core Catalan IWorker implementations.
DefaultWorkerRegistry() - Constructor for class org.writersforge.catalan.process.workers.DefaultWorkerRegistry
Creates a new instance of DefaultWorkerRegistry from default-worker-registry.xml.
DeleteProcessor - class org.writersforge.catalan.transform.xform.DeleteProcessor.
A Datum-only NodeProcessor for deleting existing XML content to other parts of the same XML tree.
DeleteProcessor(Datum) - Constructor for class org.writersforge.catalan.transform.xform.DeleteProcessor
Creates a new instance of DeleteProcessor from the XML spec.
DeleteProcessor(String, String) - Constructor for class org.writersforge.catalan.transform.xform.DeleteProcessor
Creates a new instance of DeleteProcessor.
DirectiveStack - class org.writersforge.catalan.process.workers.xml.DirectiveStack.
Format specification for placing Java Objects into a Datum tree.
DirectiveStack() - Constructor for class org.writersforge.catalan.process.workers.xml.DirectiveStack
Creates a new instance of DirectiveStack.
DirectiveStack(int, Object) - Constructor for class org.writersforge.catalan.process.workers.xml.DirectiveStack
Creates a new instance of DirectiveStack with optional maximum iterations and an input node to trigger a premature bailout.
DirectiveStack - class org.writersforge.catalan.transform.xml.DirectiveStack.
Format specification for placing Java Objects into a Datum tree.
DirectiveStack() - Constructor for class org.writersforge.catalan.transform.xml.DirectiveStack
Creates a new instance of DirectiveStack.
DirectiveStack(int, Object) - Constructor for class org.writersforge.catalan.transform.xml.DirectiveStack
Creates a new instance of DirectiveStack with optional maximum iterations and an input node to trigger a premature bailout.
DirectiveStack.Attribute - class org.writersforge.catalan.process.workers.xml.DirectiveStack.Attribute.
A Directive to create a new attribute (Datum property) inside the current element.
DirectiveStack.Attribute(String, Object) - Constructor for class org.writersforge.catalan.process.workers.xml.DirectiveStack.Attribute
Creates a new instance of AttributeName.
DirectiveStack.Attribute - class org.writersforge.catalan.transform.xml.DirectiveStack.Attribute.
A Directive to create a new attribute (Datum property) inside the current element.
DirectiveStack.Attribute(String, Object) - Constructor for class org.writersforge.catalan.transform.xml.DirectiveStack.Attribute
Creates a new instance of AttributeName.
DirectiveStack.Directive - class org.writersforge.catalan.process.workers.xml.DirectiveStack.Directive.
A single operation to perform on a node while creating a Bellows Datum tree from a list of nodes.
DirectiveStack.Directive(Object) - Constructor for class org.writersforge.catalan.process.workers.xml.DirectiveStack.Directive
Creates a new instance of Directive.
DirectiveStack.Directive - class org.writersforge.catalan.transform.xml.DirectiveStack.Directive.
A single operation to perform on a node while creating a Bellows Datum tree from a list of nodes.
DirectiveStack.Directive(Object) - Constructor for class org.writersforge.catalan.transform.xml.DirectiveStack.Directive
Creates a new instance of Directive.
DirectiveStack.EndElement - class org.writersforge.catalan.process.workers.xml.DirectiveStack.EndElement.
A Directive to close the current element.
DirectiveStack.EndElement() - Constructor for class org.writersforge.catalan.process.workers.xml.DirectiveStack.EndElement
Creates a new instance of EndElement.
DirectiveStack.EndElement - class org.writersforge.catalan.transform.xml.DirectiveStack.EndElement.
A Directive to close the current element.
DirectiveStack.EndElement() - Constructor for class org.writersforge.catalan.transform.xml.DirectiveStack.EndElement
Creates a new instance of EndElement.
DirectiveStack.Pcdata - class org.writersforge.catalan.process.workers.xml.DirectiveStack.Pcdata.
A Directive to insert PCDATA content into the current element.
DirectiveStack.Pcdata() - Constructor for class org.writersforge.catalan.process.workers.xml.DirectiveStack.Pcdata
Creates a new instance of Pcdata.
DirectiveStack.Pcdata(String) - Constructor for class org.writersforge.catalan.process.workers.xml.DirectiveStack.Pcdata
Creates a new instance of Pcdata.
DirectiveStack.Pcdata - class org.writersforge.catalan.transform.xml.DirectiveStack.Pcdata.
A Directive to insert PCDATA content into the current element.
DirectiveStack.Pcdata() - Constructor for class org.writersforge.catalan.transform.xml.DirectiveStack.Pcdata
Creates a new instance of Pcdata.
DirectiveStack.Pcdata(String) - Constructor for class org.writersforge.catalan.transform.xml.DirectiveStack.Pcdata
Creates a new instance of Pcdata.
DirectiveStack.Repeat - class org.writersforge.catalan.process.workers.xml.DirectiveStack.Repeat.
A Directive to repeat an embedded stack of directives until a certain condition is met.
DirectiveStack.Repeat(DirectiveStack) - Constructor for class org.writersforge.catalan.process.workers.xml.DirectiveStack.Repeat
Creates a new instance of Repeat.
DirectiveStack.Repeat - class org.writersforge.catalan.transform.xml.DirectiveStack.Repeat.
A Directive to repeat an embedded stack of directives until a certain condition is met.
DirectiveStack.Repeat(DirectiveStack) - Constructor for class org.writersforge.catalan.transform.xml.DirectiveStack.Repeat
Creates a new instance of Repeat.
DirectiveStack.StartElement - class org.writersforge.catalan.process.workers.xml.DirectiveStack.StartElement.
A Directive to start a new Datum element.
DirectiveStack.StartElement() - Constructor for class org.writersforge.catalan.process.workers.xml.DirectiveStack.StartElement
Creates a new instance of StartElement.
DirectiveStack.StartElement(String) - Constructor for class org.writersforge.catalan.process.workers.xml.DirectiveStack.StartElement
Creates a new instance of StartElement.
DirectiveStack.StartElement - class org.writersforge.catalan.transform.xml.DirectiveStack.StartElement.
A Directive to start a new Datum element.
DirectiveStack.StartElement() - Constructor for class org.writersforge.catalan.transform.xml.DirectiveStack.StartElement
Creates a new instance of StartElement.
DirectiveStack.StartElement(String) - Constructor for class org.writersforge.catalan.transform.xml.DirectiveStack.StartElement
Creates a new instance of StartElement.
DispatchWorker - class org.writersforge.catalan.process.workers.dispatch.DispatchWorker.
IWorker implementation which dispatches nodes to various combinations of workers depending on regular expression matches or the Java Class of target nodes.
DispatchWorker() - Constructor for class org.writersforge.catalan.process.workers.dispatch.DispatchWorker
Creates a new instance of DispatchWorker.
debugPrint() - Method in class org.writersforge.catalan.layout.Page
Creates a debug string which represents this Page object
delete() - Method in class org.writersforge.catalan.process.workers.io.IOAdapter
Deletes the backing file of the wrapped object, if possible.
deleteNodes(String, NodeSelection) - Method in class org.writersforge.catalan.process.queue.QueueManager
Deletes the selected nodes in the given queue.
deleteQueue(String) - Method in class org.writersforge.catalan.process.queue.QueueManager
Removes the queue with the given name.
doWork() - Method in class org.writersforge.catalan.process.commands.BaseCommandWorker
Core executor for descendents of BaseWorker.
doWork() - Method in class org.writersforge.catalan.process.workers.BaseWorker
Core executor for descendents of BaseWorker.
doWork() - Method in class org.writersforge.catalan.process.workers.control.ControlWorker
Core executor for descendents of BaseWorker.
doWork() - Method in class org.writersforge.catalan.process.workers.dispatch.DispatchWorker
Core executor for descendents of BaseWorker.
doWork() - Method in class org.writersforge.catalan.process.workers.log.LogWorker
Core executor for descendents of BaseWorker.
doWork() - Method in class org.writersforge.catalan.process.workers.partition.PartitionWorker
Core executor for descendents of BaseWorker.
doWork() - Method in class org.writersforge.catalan.process.workers.pdf.PdfWorker
Core executor for descendents of BaseWorker.
doWork() - Method in class org.writersforge.catalan.process.workers.queue.QueueNodeWorker
Core executor for descendents of BaseWorker.
doWork() - Method in class org.writersforge.catalan.process.workers.queue.QueueSortWorker
Core executor for descendents of BaseWorker.
doWork() - Method in class org.writersforge.catalan.process.workers.queue.QueueWorker
Core executor for descendents of BaseWorker.
doWork() - Method in class org.writersforge.catalan.process.workers.sql.SqlWorker
Core executor for descendents of BaseWorker.
doWork() - Method in class org.writersforge.catalan.process.workers.velocity.VelocityWorker
Core executor for descendents of BaseWorker.
doWork() - Method in class org.writersforge.catalan.process.workers.xml.XmlBuilderWorker
Core executor for descendents of BaseWorker.

E

EQUAL_MASK - Static variable in class org.writersforge.catalan.layout.Relation
Require equal to distance
ERROR - Static variable in class org.writersforge.catalan.process.queue.AlertPriority
An ERROR Alert, signalling that the transform may continue, but results will probably be flawed or inconsistent.
EmptyProperties - class org.writersforge.catalan.process.properties.EmptyProperties.
IWorkProperties implementation with no properties set.
EmptyProperties() - Constructor for class org.writersforge.catalan.process.properties.EmptyProperties
 
ExportCommand - class org.writersforge.catalan.process.workers.io.ExportCommand.
Implementation of the "export" command.
ExportCommand() - Constructor for class org.writersforge.catalan.process.workers.io.ExportCommand
Creates a new instance of ExportCommand.
ExportJavaCommand - class org.writersforge.catalan.process.workers.io.ExportJavaCommand.
Implementation of "export-java" command.
ExportJavaCommand() - Constructor for class org.writersforge.catalan.process.workers.io.ExportJavaCommand
Creates a new instance of ExportJavaCommand.
ExportJavaProcessor - class org.writersforge.catalan.transform.io.ExportJavaProcessor.
Catalan processor which exports the contents of one or more java classes to the proper file and package path.
ExportJavaProcessor(Datum) - Constructor for class org.writersforge.catalan.transform.io.ExportJavaProcessor
Creates a new instance of ExportJavaProcessor from the XML spec.
ExportProcessor - class org.writersforge.catalan.transform.io.ExportProcessor.
A processor which exports data from data nodes into files and URLs.
ExportProcessor(Datum) - Constructor for class org.writersforge.catalan.transform.io.ExportProcessor
Creates a new instance of ExportProcessor from the XML spec.
ExportProcessor(File, boolean, boolean) - Constructor for class org.writersforge.catalan.transform.io.ExportProcessor
Creates a new instance of ExportProcessor.
ExtentStyle - interface org.writersforge.catalan.layout.style.ExtentStyle.
The requested geometrical size of an area.
ExtractCommand - class org.writersforge.catalan.process.workers.text.ExtractCommand.
Implementation of "extract" command.
ExtractCommand() - Constructor for class org.writersforge.catalan.process.workers.text.ExtractCommand
Creates a new instance of ExtractCommand.
end(List) - Method in class org.writersforge.catalan.transform.BaseNodeProcessor
Ends the current traversal.
end(List) - Method in class org.writersforge.catalan.transform.GroupProcessor
Ends the current traversal.
end(List) - Method in class org.writersforge.catalan.transform.external.VelocityProcessor
Ends the current traversal.
end(List) - Method in class org.writersforge.catalan.transform.io.ExportProcessor
Ends the current traversal.
end(List) - Method in class org.writersforge.catalan.transform.text.Concatenator
Ends the current traversal.
end(List) - Method in class org.writersforge.catalan.transform.text.FromAsciiConverter
Ends the current traversal.
end(List) - Method in class org.writersforge.catalan.transform.text.ToAsciiConverter
Ends the current traversal.
end(List) - Method in class org.writersforge.catalan.transform.xml.ObjectToDatum
Ends the current traversal.
endBook(Book) - Method in class org.writersforge.catalan.renderers.PdfRenderer
Performs any cleanup that the Renderer must do at the end of the rendering process
endBook(Book) - Method in class org.writersforge.catalan.renderers.Renderer
Performs any cleanup that the Renderer must do at the end of the rendering process.
endBook(Book) - Method in class org.writersforge.catalan.renderers.TextRenderer
Performs any cleanup that the Renderer must do at the end of the rendering process.
endPage(Page) - Method in class org.writersforge.catalan.renderers.PdfRenderer
Performs any cleanup that the Renderer must do after every Page.
endPage(Page) - Method in class org.writersforge.catalan.renderers.Renderer
Performs any cleanup that the Renderer must do after every Page.
execute() - Method in class org.writersforge.catalan.util.TransformTask
Runs the Transformer with the supplied parameters.
extractText(Object) - Method in class org.writersforge.catalan.process.workers.text.BaseTextCommand
Extracts the text content from arbitrary node formats.
extractText(String) - Method in class org.writersforge.catalan.text.extractors.BraceMatchSplitter
Extracts fragments of text from the input text document.
extractText(String) - Method in interface org.writersforge.catalan.text.extractors.ITextExtractor
Extracts fragments of text from the input text document.
extractText(String) - Method in class org.writersforge.catalan.text.extractors.LineSplitter
Extracts fragments of text from the input text document.
extractText(String) - Method in class org.writersforge.catalan.text.extractors.ParagraphSplitter
Extracts fragments of text from the input text document.
extractText(String) - Method in class org.writersforge.catalan.text.extractors.RegexpExtractor
Extracts fragments of text from the input text document.
extractText(String) - Method in class org.writersforge.catalan.text.extractors.RegexpLineSplitter
Extracts fragments of text from the input text document.
extractText(String) - Method in class org.writersforge.catalan.text.extractors.RegexpSplitter
Extracts fragments of text from the input text document.
extractText(String) - Method in class org.writersforge.catalan.text.extractors.TokenSplitter
Extracts fragments of text from the input text document.
extractValue(int, String) - Method in class org.writersforge.catalan.text.AsciiFieldManager
Parses the asciiData input data and pulls out the data corresponding to the given field index, then converts that data to the correct Java data type.

F

FATAL - Static variable in class org.writersforge.catalan.process.queue.AlertPriority
A FATAL Alert, signalling that the transform should stop immediately.
FIXED_CHAR_MULT - Static variable in class org.writersforge.catalan.layout.style.FontStyleMetrics
Default multiplier for converting font point size into character width.
FONT_STYLE_BOLD - Static variable in interface org.writersforge.catalan.layout.style.FontStyle
Enumeration value for specifying bold font style
FONT_STYLE_ITALIC - Static variable in interface org.writersforge.catalan.layout.style.FontStyle
Enumeration value for specifying italic font style
FONT_STYLE_PLAIN - Static variable in interface org.writersforge.catalan.layout.style.FontStyle
Enumeration value for specifying plain font style
Field - class org.writersforge.catalan.process.workers.sql.Field.
A single field in an SQL table.
Field() - Constructor for class org.writersforge.catalan.process.workers.sql.Field
Creates a new instance of Field.
Field(boolean, TypeMap[]) - Constructor for class org.writersforge.catalan.process.workers.sql.Field
Creates a new instance of Field with the specified primitive types policy.
FontStyle - interface org.writersforge.catalan.layout.style.FontStyle.
The font style for a span of text.
FontStyleMetrics - class org.writersforge.catalan.layout.style.FontStyleMetrics.
Wrapper class to calculate font metrics based on a FontStyle object.
FontStyleMetrics(FontStyle) - Constructor for class org.writersforge.catalan.layout.style.FontStyleMetrics
Creates a new instance of FontStyleMetrics from the FontStyle.
FontStyleMetrics(String, int, int) - Constructor for class org.writersforge.catalan.layout.style.FontStyleMetrics
Creates a new instance of FontStyleMetrics with the explicit font parameters and a calculated font height.
FontStyleMetrics(String, int, int, int) - Constructor for class org.writersforge.catalan.layout.style.FontStyleMetrics
Creates a new instance of FontStyleMetrics with the explicit font parameters.
ForEachOp - class org.writersforge.catalan.templates.generic.ForEachOp.
A template op wrapper for <for-each>.
ForEachOp(Datum, StyleMap) - Constructor for class org.writersforge.catalan.templates.generic.ForEachOp
Creates a new instance of ForEachOp.
ForEachOp(Datum, StyleMap, StyleChain) - Constructor for class org.writersforge.catalan.templates.generic.ForEachOp
Creates a new instance of ForEachOp with an optional StyleChain fallback.
FromAsciiCommand - class org.writersforge.catalan.process.workers.text.FromAsciiCommand.
Implementation of "from-ascii" command.
FromAsciiCommand() - Constructor for class org.writersforge.catalan.process.workers.text.FromAsciiCommand
Creates a new instance of FromAsciiCommand.
FromAsciiConverter - class org.writersforge.catalan.transform.text.FromAsciiConverter.
A packed ASCII field processor which explodes a packed ASCII data node into a collection of Java objects.
FromAsciiConverter(Datum) - Constructor for class org.writersforge.catalan.transform.text.FromAsciiConverter
Creates a new instance of FromAsciiConverter from the XML spec.
FromAsciiConverter(String) - Constructor for class org.writersforge.catalan.transform.text.FromAsciiConverter
Creates a new instance of FromAsciiConverter.
filterFragments(String[]) - Method in interface org.writersforge.catalan.text.fragfilters.IFragmentFilter
Processes an array of text fragments into another array of text fragments.
filterText(String) - Method in class org.writersforge.catalan.text.filters.CaseFilter
Sends input document through a modifying filter.
filterText(String) - Method in interface org.writersforge.catalan.text.filters.ITextFilter
Sends input document through a modifying filter.
filterText(String) - Method in class org.writersforge.catalan.text.filters.MultiLineCommentStripper
Sends input document through a modifying filter.
filterText(String) - Method in class org.writersforge.catalan.text.filters.Normalizer
Sends input document through a modifying filter.
filterText(String) - Method in class org.writersforge.catalan.text.filters.SingleLineCommentStripper
Sends input document through a modifying filter.
filterText(String) - Method in class org.writersforge.catalan.text.filters.TextReplacer
Sends input document through a modifying filter.
filterText(String) - Method in class org.writersforge.catalan.text.filters.TextResolver
Sends input document through a modifying filter.
findColor(String) - Method in class org.writersforge.catalan.layout.style.DatumStyleMap
Returns a Color object corresponding to the given name.
findColor(String) - Method in class org.writersforge.catalan.layout.style.DefaultStyle
Returns a Color object corresponding to the given name.
findColor(String) - Method in interface org.writersforge.catalan.layout.style.StyleMap
Returns a Color object corresponding to the given name.
findIndexes(String) - Method in class org.writersforge.catalan.process.workers.partition.PartitionIndexer
Calculates partition indexes according to the supplied scanners.
findRelation(Class) - Method in class org.writersforge.catalan.layout.Constraint
Searches this Constraint for a Relation object of the given class.
findRelation(Class, int) - Method in class org.writersforge.catalan.layout.Constraint
Searches this Constraint for a Relation object of the given class.
fitsInRegion(LayoutArea) - Method in class org.writersforge.catalan.layout.AbstractLayoutEngine
Checks to see if the given area will fit anywhere in the current layout region.
fitsInRegion(LayoutArea, Rectangle, List) - Method in class org.writersforge.catalan.layout.AsciiLayout
Checks to see if the area will fit in the given region.
fitsInRegion(LayoutArea) - Method in interface org.writersforge.catalan.layout.LayoutEngine
Checks to see if the given area will fit anywhere in the current layout region.
fitsInRegion(LayoutArea, Rectangle, List) - Method in interface org.writersforge.catalan.layout.LayoutEngine
Checks to see if the area will fit in the given region.
fitsInRegion(LayoutArea, Rectangle, List) - Method in class org.writersforge.catalan.layout.SimpleFlowLayout
Checks to see if the area will fit in the given region.
fitsOnPage(Page, LayoutArea) - Method in class org.writersforge.catalan.layout.AsciiLayout
Checks to see if the area will fit on the given Page.
flush() - Method in class org.writersforge.catalan.layout.LayoutContext
Removes all renderable areas from the queue.
format(LogRecord) - Method in class org.writersforge.catalan.util.CatalanLogFormatter
Format the given log record and return the formatted string.

G

GREATER_THAN_EQUAL_MASK - Static variable in class org.writersforge.catalan.layout.Relation
Require greater than or equal to distance
GREATER_THAN_MASK - Static variable in class org.writersforge.catalan.layout.Relation
Require greater than distance
GenericGenerator - class org.writersforge.catalan.GenericGenerator.
Content generator for creating PDFs, HTML, and ASCII text files from arbitrary XML data formats, using a layout-template XML file to filter and position the data in the output medium.
GenericGenerator() - Constructor for class org.writersforge.catalan.GenericGenerator
 
GenericOp - class org.writersforge.catalan.templates.generic.GenericOp.
Base class for all template ops.
GenericOp(Datum, StyleMap) - Constructor for class org.writersforge.catalan.templates.generic.GenericOp
Creates a new instance of GenericOp.
GenericOp(Datum, StyleMap, StyleChain) - Constructor for class org.writersforge.catalan.templates.generic.GenericOp
Creates a new instance of GenericOp with an optional StyleChain argument.
GenericRegionMap - class org.writersforge.catalan.templates.generic.GenericRegionMap.
A RegionMap that is backed by a Generic XML <region-map> element.
GenericRegionMap(ListDatum) - Constructor for class org.writersforge.catalan.templates.generic.GenericRegionMap
Creates a new instance of GenericRegionMap.
GenericTemplate - class org.writersforge.catalan.templates.GenericTemplate.
A configurable template driven by an XML layout template which can transform arbitrary XML inputs into layouts.
GenericTemplate() - Constructor for class org.writersforge.catalan.templates.GenericTemplate
 
GroupOp - class org.writersforge.catalan.templates.generic.GroupOp.
A vertical or horizontal container of other ops, depending on whether the op was a <row> or <column> element.
GroupOp(Datum, StyleMap) - Constructor for class org.writersforge.catalan.templates.generic.GroupOp
Creates a new instance of a vertically oriented GroupOp.
GroupOp(Datum, StyleMap, StyleChain) - Constructor for class org.writersforge.catalan.templates.generic.GroupOp
Creates a new instance of a vertically oriented GroupOp with an optional StyleChain fallback.
GroupOp(Datum, StyleMap, int) - Constructor for class org.writersforge.catalan.templates.generic.GroupOp
Creates a new instance of a GroupOp.
GroupOp(Datum, StyleMap, StyleChain, int) - Constructor for class org.writersforge.catalan.templates.generic.GroupOp
Creates a new instance of a GroupOp with an optional StyleChain fallback.
GroupProcessor - class org.writersforge.catalan.transform.GroupProcessor.
Composite NodeProcessor which can combine multiple processors into a single easily referenced one.
GroupProcessor(Datum, ProcessorRegistry) - Constructor for class org.writersforge.catalan.transform.GroupProcessor
Creates a new instance of GroupProcessor from the XML spec.
GroupProcessor(NodeProcessor[], Integer, Integer, String, Class) - Constructor for class org.writersforge.catalan.transform.GroupProcessor
Creates a new instance of GroupProcessor to operate on a given range of input elements.
getAbortOnFail() - Method in class org.writersforge.catalan.process.workers.queue.QueueProperties
Retrieves the value of the "abort-on-fail" property.
getAcceptedAreas() - Method in class org.writersforge.catalan.layout.LayoutContext
Returns an array of areas ready to be rendered onto a Page.
getActiveNodes() - Method in class org.writersforge.catalan.process.commands.CommandContext
Retrieves the active nodes the command should operate on.
getActiveNodes() - Method in class org.writersforge.catalan.process.workers.BaseWorker
Retrieves the nodes currently active for processing.
getActiveQueue() - Method in class org.writersforge.catalan.process.workers.BaseWorker
Retrieves the primary target queue for this IWorker.
getAlertCount() - Method in class org.writersforge.catalan.process.queue.AlertQueue
Calculates how many distinct Alert objects exist in the queue.
getAlertCount(AlertPriority) - Method in class org.writersforge.catalan.process.queue.AlertQueue
Calculates how many distinct Alert objects exist in the queue with the given priority.
getAlertQueue() - Method in class org.writersforge.catalan.process.workspace.BaseWorkspace
Retrieves the AlertQueue for this IWorkspace.
getAlertQueue() - Method in interface org.writersforge.catalan.process.workspace.IWorkspace
Retrieves the AlertQueue for this IWorkspace.
getAlerts() - Method in class org.writersforge.catalan.process.queue.AlertQueue
Retrieves all Alert objects in the queue.
getAlerts(AlertPriority) - Method in class org.writersforge.catalan.process.queue.AlertQueue
Retrieves all Alert objects in the queue of the given priority.
getAppend() - Method in class org.writersforge.catalan.process.workers.io.IoProperties
Retrieves the value of the "append" property.
getAreaStyle(String) - Method in class org.writersforge.catalan.layout.style.DatumStyleMap
Returns the named area style from this map.
getAreaStyle(String) - Method in class org.writersforge.catalan.layout.style.DefaultStyle
Returns the named area style from this map.
getAreaStyle(String) - Method in interface org.writersforge.catalan.layout.style.StyleMap
Returns the named area style from this map.
getAreaStyles() - Method in class org.writersforge.catalan.layout.style.StyleChain
Returns an array of all AreaStyle objects in this chain.
getAreas(int) - Method in class org.writersforge.catalan.layout.Page
Indexed getter for property areas, the layout areas associated with this Page.
getAreas() - Method in class org.writersforge.catalan.layout.Page
Getter for property areas, the layout areas associated with this Page.
getAscent() - Method in class org.writersforge.catalan.layout.style.FontStyleMetrics
Returns the ascent for this font.
getAttribute() - Method in class org.writersforge.catalan.process.workers.xml.XmlCommonProperties
Retrieves the value of the "attribute" property.
getAttributeValue() - Method in class org.writersforge.catalan.process.workers.xml.XmlCommonProperties
Retrieves the value of the "attribute-value" property.
getBackgroundColor() - Method in interface org.writersforge.catalan.layout.style.AreaStyle
Returns the background color of this area.
getBackgroundColor() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper
Returns the background color of this area.
getBackgroundColor() - Method in class org.writersforge.catalan.layout.style.DefaultStyle
Returns the background color of this area.
getBackgroundColor() - Method in class org.writersforge.catalan.layout.style.StyleChain
Returns the background color of this area.
getBaseDir() - Method in class org.writersforge.catalan.process.workers.io.IoProperties
Retrieves the value of the "base-dir" property.
getBeforeNode() - Method in class org.writersforge.catalan.process.workers.queue.QueueProperties
Retrieves the value of the "before-node" property.
getBook() - Method in class org.writersforge.catalan.layout.Page
Getter for property book, the owning Book for this Page.
getBorderColor() - Method in interface org.writersforge.catalan.layout.style.BorderStyle
Returns the color of the border enclosing this area.
getBorderColor() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper
Returns the color of the border enclosing this area.
getBorderColor() - Method in class org.writersforge.catalan.layout.style.DefaultStyle
Returns the color of the border enclosing this area.
getBorderColor() - Method in class org.writersforge.catalan.layout.style.StyleChain
Returns the color of the border enclosing this area.
getBorderWidth() - Method in interface org.writersforge.catalan.layout.style.BorderStyle
Returns the width of the border enclosing this area.
getBorderWidth() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper
Returns the width of the border enclosing this area.
getBorderWidth() - Method in class org.writersforge.catalan.layout.style.DefaultStyle
Returns the width of the border enclosing this area.
getBorderWidth() - Method in class org.writersforge.catalan.layout.style.StyleChain
Returns the width of the border enclosing this area.
getCaseStyle() - Method in class org.writersforge.catalan.process.workers.text.TextProperties
Retrieves the value of the "style" property.
getChain() - Method in class org.writersforge.catalan.templates.generic.GenericOp
Returns the StyleChain for this op.
getCheckCondition() - Method in class org.writersforge.catalan.process.workers.sql.Field
Retrieves the CHECK condition for this field.
getCheckCondition() - Method in class org.writersforge.catalan.process.workers.sql.SqlTable
Retrieves the table-level CHECK condition.
getCheckCondition() - Method in class org.writersforge.catalan.transform.text.SqlTable.Field
Retrieves the CHECK condition for this field.
getCheckCondition() - Method in class org.writersforge.catalan.transform.text.SqlTable
Retrieves the table-level CHECK condition.
getChildren(int) - Method in class org.writersforge.catalan.layout.LayoutArea
Indexed getter for property children, the child layout areas.
getChildren() - Method in class org.writersforge.catalan.layout.LayoutArea
Getter for property children, the child layout areas.
getChildren(int) - Method in class org.writersforge.catalan.layout.LayoutGroup
Indexed getter for property children, the child layout areas.
getChildren() - Method in class org.writersforge.catalan.layout.LayoutGroup
Getter for property children, the child layout areas.
getCollapse() - Method in class org.writersforge.catalan.process.workers.javabean.JavaBeanProperties
Retrieves the value of the "collapse" property.
getCollapse() - Method in class org.writersforge.catalan.process.workers.xml.XmlCommonProperties
Retrieves the value of the "collapse" property.
getColumnFlowSelect() - Method in class org.writersforge.catalan.templates.generic.TableOp
Returns the 'select' property for the <column-flow> op, or an empty string if 'select' is not specified.
getColumnHeaderSelect() - Method in class org.writersforge.catalan.templates.generic.TableOp
Returns the 'select' property for the <column-headers> op, or an empty string if 'select' is not specified.
getCommand() - Method in class org.writersforge.catalan.process.properties.CommonProperties
Retrieves the value of the "command" property.
getCommands() - Method in class org.writersforge.catalan.process.commands.BaseCommandWorker
Retrieves all command objects for this worker.
getCommands() - Method in class org.writersforge.catalan.process.workers.html.HtmlWorker
Retrieves all command objects for this worker.
getCommands() - Method in class org.writersforge.catalan.process.workers.io.IoWorker
Retrieves all command objects for this worker.
getCommands() - Method in class org.writersforge.catalan.process.workers.javabean.JavaBeanWorker
Retrieves all command objects for this worker.
getCommands() - Method in class org.writersforge.catalan.process.workers.text.TextWorker
Retrieves all command objects for this worker.
getCommands() - Method in class org.writersforge.catalan.process.workers.xml.XmlWorker
Retrieves all command objects for this worker.
getContent() - Method in class org.writersforge.catalan.process.workers.queue.QueueProperties
Retrieves the value of the "content" property.
getContent() - Method in class org.writersforge.catalan.process.workers.xml.XmlCommonProperties
Retrieves the value of the "content" property.
getConvertType() - Method in class org.writersforge.catalan.process.workers.queue.QueueProperties
Retrieves the value of the "convert-type" property.
getCount(int) - Method in class org.writersforge.catalan.process.properties.CommonProperties
Retrieves the value of the "count" property.
getCurrentArea() - Method in class org.writersforge.catalan.layout.LayoutContext
Returns the LayoutArea object most recently pulled off the stack.
getCurrentPage() - Method in class org.writersforge.catalan.layout.Book
Gets the current page object in this Book.
getCurrentPage() - Method in class org.writersforge.catalan.templates.RenderTemplate
Retrieves the current page index
getCurrentPageNumber() - Method in class org.writersforge.catalan.layout.Book
Gets the current page number in this Book.
getCurrentRegion() - Method in class org.writersforge.catalan.layout.LayoutContext
Retrieves the cached current rendering region.
getData() - Method in class org.writersforge.catalan.layout.Book
Gets the Book's raw input data
getDataQueues() - Method in interface org.writersforge.catalan.process.workspace.IWorkspace
Retrieves the QueueManager responsible for all queues.
getDataQueues() - Method in class org.writersforge.catalan.process.workspace.XmlWorkspace
Retrieves the QueueManager responsible for all queues.
getDateFormat() - Method in class org.writersforge.catalan.process.workers.queue.QueueProperties
Retrieves the value of the "date-format" property.
getDatum() - Method in class org.writersforge.catalan.templates.generic.GenericOp
Returns the op itself.
getDatumProperty(String) - Method in class org.writersforge.catalan.templates.generic.GenericOp
Returns a property value from the encapsulated Datum op.
getDdl() - Method in class org.writersforge.catalan.process.workers.sql.SqlTable
Retrieves the original SQL DDL for the table.
getDdl() - Method in class org.writersforge.catalan.transform.text.SqlTable
Retrieves the original SQL DDL for the table.
getDefault() - Method in class org.writersforge.catalan.process.workers.OptionalPropertyInfo
Retrieves the default value of this property.
getDefaultAreaStyle() - Method in class org.writersforge.catalan.layout.style.DatumStyleMap
Returns the default area style from this map.
getDefaultAreaStyle() - Method in class org.writersforge.catalan.layout.style.DefaultStyle
Returns the default area style from this map.
getDefaultAreaStyle() - Method in interface org.writersforge.catalan.layout.style.StyleMap
Returns the default area style from this map.
getDefaultFont() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper
Returns the default FontStyle of this text.
getDefaultFont() - Method in class org.writersforge.catalan.layout.style.DefaultStyle
Returns the default FontStyle of this text.
getDefaultFont() - Method in class org.writersforge.catalan.layout.style.StyleChain
Returns the default FontStyle of this text.
getDefaultFont() - Method in interface org.writersforge.catalan.layout.style.TextStyle
Returns the default FontStyle of this text.
getDefaultFontStyle() - Method in class org.writersforge.catalan.layout.style.DatumStyleMap
Returns the default font style from this map.
getDefaultFontStyle() - Method in class org.writersforge.catalan.layout.style.DefaultStyle
Returns the default font style from this map.
getDefaultFontStyle() - Method in interface org.writersforge.catalan.layout.style.StyleMap
Returns the default font style from this map.
getDefaultPageHeight() - Method in class org.writersforge.catalan.templates.GenericTemplate
Retrieves the default Page height for this template.
getDefaultPageHeight() - Method in class org.writersforge.catalan.templates.RenderTemplate
Retrieves the default Page height for this template.
getDefaultPageWidth() - Method in class org.writersforge.catalan.templates.GenericTemplate
Retrieves the default Page width for this template.
getDefaultPageWidth() - Method in class org.writersforge.catalan.templates.RenderTemplate
Retrieves the default Page width for this template.
getDefaultProperties() - Method in class org.writersforge.catalan.process.workers.BaseJob
Retrieves the default properties for this IWorker.
getDefaultProperties() - Method in class org.writersforge.catalan.process.workers.BaseWorker
Retrieves the default properties for this IWorker.
getDefaultProperties() - Method in interface org.writersforge.catalan.process.workers.IWorker
Retrieves the default properties for this IWorker.
getDefaultProperties() - Method in class org.writersforge.catalan.process.workers.XmlJob
Retrieves the default properties for this IWorker.
getDefaultQueue() - Method in class org.writersforge.catalan.process.queue.QueueManager
Retrieves the default IQueue.
getDefaultTextStyle() - Method in class org.writersforge.catalan.layout.style.DatumStyleMap
Returns the default text style from this map.
getDefaultTextStyle() - Method in class org.writersforge.catalan.layout.style.DefaultStyle
Returns the default text style from this map.
getDefaultTextStyle() - Method in interface org.writersforge.catalan.layout.style.StyleMap
Returns the default text style from this map.
getDefaultValue() - Method in class org.writersforge.catalan.process.workers.sql.Field
Retrieves the default value for this field.
getDefaultValue() - Method in class org.writersforge.catalan.transform.text.SqlTable.Field
Retrieves the default value for this field.
getDelimiters() - Method in class org.writersforge.catalan.process.workers.text.TextProperties
Retrieves the value of the "delimiters" property for the tokenize command.
getDescent() - Method in class org.writersforge.catalan.layout.style.FontStyleMetrics
Returns the descent for this font.
getDescription() - Method in interface org.writersforge.catalan.layout.style.AreaStyle
Returns an optional text description of this area.
getDescription() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper
Returns an optional text description of this area.
getDescription() - Method in class org.writersforge.catalan.layout.style.DefaultStyle
Returns an optional text description of this area.
getDescription() - Method in class org.writersforge.catalan.layout.style.StyleChain
Returns an optional text description of this area.
getDescription() - Method in class org.writersforge.catalan.process.workers.DefaultWorkerInfo
Retrieves a user-friendly description of this worker or command.
getDescription() - Method in interface org.writersforge.catalan.process.workers.IWorkMetadata
Retrieves a description of this worker or command.
getDescription() - Method in class org.writersforge.catalan.process.workers.PropertyInfo
Retrieves the user-friendly description for this property.
getDescription() - Method in class org.writersforge.catalan.process.workers.WorkMetadata
Retrieves a description of the associated object.
getDestQueue() - Method in class org.writersforge.catalan.process.workers.queue.QueueProperties
Retrieves the value of the "dest-queue" property.
getDestination() - Method in class org.writersforge.catalan.process.workers.xml.XmlCommonProperties
Retrieves the value of the "dest" property.
getDestinationNodes(Datum, XmlCommonProperties) - Method in class org.writersforge.catalan.process.workers.xml.BaseQueryCommand
Retrieves the XML elements declared in the "dest" property.
getDestinationNodes(Datum) - Method in class org.writersforge.catalan.transform.xform.CopyProcessor
Finds the Datum nodes to perform the transformation on.
getDestinationNodes(Datum) - Method in class org.writersforge.catalan.transform.xform.MoveProcessor
Finds the Datum nodes to perform the transformation on.
getDistance() - Method in class org.writersforge.catalan.layout.Relation
Getter for property distance, a scalar measure to use with comparisons.
getEncodeXml() - Method in class org.writersforge.catalan.process.workers.io.IoProperties
Retrieves the value of the "encode-xml" property.
getEnd() - Method in class org.writersforge.catalan.layout.Markup
Getter for property end, the index of the last text character in the style span.
getEnd() - Method in class org.writersforge.catalan.layout.StyledText.Span
Getter for property end, the index of the last text character in the style span.
getEnd() - Method in class org.writersforge.catalan.process.workers.partition.Partition
Retrieves the ending pattern for this parition.
getEndIndex(int) - Method in class org.writersforge.catalan.process.properties.CommonProperties
Retrieves the value of the "end-index" property.
getEndIndex() - Method in class org.writersforge.catalan.process.workers.partition.PartitionRange
Retrieves the ending index of this partition.
getEndToken() - Method in class org.writersforge.catalan.process.workers.text.TextProperties
Retrieves the value of the "end-token" property.
getException() - Method in class org.writersforge.catalan.process.queue.Alert
Retrieves the optional thrown exception which triggered the alert.
getExpand() - Method in class org.writersforge.catalan.process.workers.xml.XmlCommonProperties
Retrieves the value of the "expand" property.
getExtents() - Method in class org.writersforge.catalan.layout.LayoutArea
Getter for property extents, the actual extents for this area.
getFieldArraySize(int) - Method in class org.writersforge.catalan.text.AsciiFieldManager
Retrieves the number of array elements of the given field.
getFieldCount() - Method in class org.writersforge.catalan.text.AsciiFieldManager
Calculates the number of discrete fields in the format spec.
getFieldLength(int) - Method in class org.writersforge.catalan.text.AsciiFieldManager
Retrieves the length of the given field in its ASCII version.
getFieldSpec() - Method in class org.writersforge.catalan.process.workers.text.TextProperties
Retrieves the value of the "field-spec" property.
getFieldType(int) - Method in class org.writersforge.catalan.text.AsciiFieldManager
Retrieves the Java type that corresponds to the given field number.
getFields() - Method in class org.writersforge.catalan.process.workers.sql.SqlTable
Retrieves all fields in this table
getFields() - Method in class org.writersforge.catalan.process.workers.velocity.VelocityProperties
Retrieves the value of the "fields" property.
getFields() - Method in class org.writersforge.catalan.transform.text.SqlTable
Retrieves all fields in this table
getFile() - Method in class org.writersforge.catalan.templates.generic.ImageOp
Retrieves the file path for the image that this op should render.
getFirstLineIndent() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper
Returns the first line indent property of this text.
getFirstLineIndent() - Method in class org.writersforge.catalan.layout.style.DefaultStyle
Returns the first line indent property of this text.
getFirstLineIndent() - Method in class org.writersforge.catalan.layout.style.StyleChain
Returns the first line indent property of this text.
getFirstLineIndent() - Method in interface org.writersforge.catalan.layout.style.TextStyle
Returns the first line indent property of this text.
getFlowTemplate(String) - Method in class org.writersforge.catalan.templates.Section
Returns a Datum object that embodies the flow template for the named region.
getFontColor() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper
Returns the color of this run of text.
getFontColor() - Method in class org.writersforge.catalan.layout.style.DefaultStyle
Returns the color of this run of text.
getFontColor() - Method in interface org.writersforge.catalan.layout.style.FontStyle
Returns the color of this run of text.
getFontColor() - Method in class org.writersforge.catalan.layout.style.FontStyleMetrics
Returns the color of this run of text.
getFontColor() - Method in class org.writersforge.catalan.layout.style.StyleChain
Returns the color of this run of text.
getFontHeight() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper
Estimates the height of the font in point size.
getFontHeight() - Method in class org.writersforge.catalan.layout.style.DefaultStyle
Estimates the height of the font in point size.
getFontHeight() - Method in interface org.writersforge.catalan.layout.style.FontStyle
Estimates the height of the font in point size.
getFontHeight() - Method in class org.writersforge.catalan.layout.style.FontStyleMetrics
Estimates the height of the font in point size.
getFontHeight() - Method in class org.writersforge.catalan.layout.style.StyleChain
Estimates the height of the font in point size.
getFontName() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper
Returns the font name property of the style.
getFontName() - Method in class org.writersforge.catalan.layout.style.DefaultStyle
Returns the font name property of the style.
getFontName() - Method in interface org.writersforge.catalan.layout.style.FontStyle
Returns the font name property of the style.
getFontName() - Method in class org.writersforge.catalan.layout.style.FontStyleMetrics
Getter for property name, the name of the font.
getFontName() - Method in class org.writersforge.catalan.layout.style.StyleChain
Returns the font name property of the style.
getFontSize() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper
Returns the font size property of the style.
getFontSize() - Method in class org.writersforge.catalan.layout.style.DefaultStyle
Returns the font size property of the style.
getFontSize() - Method in interface org.writersforge.catalan.layout.style.FontStyle
Returns the font size property of the style.
getFontSize() - Method in class org.writersforge.catalan.layout.style.FontStyleMetrics
Getter for property size, the point size of the font.
getFontSize() - Method in class org.writersforge.catalan.layout.style.StyleChain
Returns the font size property of the style.
getFontStyle() - Method in class org.writersforge.catalan.layout.StyledText
Returns the font style of this object
getFontStyle(String) - Method in class org.writersforge.catalan.layout.style.DatumStyleMap
Returns the named font style from this map.
getFontStyle() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper
Returns the font style property of the style.
getFontStyle() - Method in class org.writersforge.catalan.layout.style.DefaultStyle
Returns the font style property of the style.
getFontStyle(String) - Method in class org.writersforge.catalan.layout.style.DefaultStyle
Returns the named font style from this map.
getFontStyle() - Method in interface org.writersforge.catalan.layout.style.FontStyle
Returns the font style property of the style.
getFontStyle() - Method in class org.writersforge.catalan.layout.style.FontStyleMetrics
Getter for property style: plain, bold, or italic.
getFontStyle() - Method in class org.writersforge.catalan.layout.style.StyleChain
Returns the font style property of the style.
getFontStyle(String) - Method in interface org.writersforge.catalan.layout.style.StyleMap
Returns the named font style from this map.
getFontStyles() - Method in class org.writersforge.catalan.layout.style.StyleChain
Returns an array of all FontStyle objects in this chain.
getForeignKeys() - Method in class org.writersforge.catalan.process.workers.sql.SqlTable
Retrieves an array of all foreign key fields in this table.
getForeignKeys() - Method in class org.writersforge.catalan.transform.text.SqlTable
Retrieves an array of all foreign key fields in this table.
getFormat() - Method in class org.writersforge.catalan.process.workers.io.IoProperties
Retrieves the value of the "format" property.
getFreeSpace() - Method in class org.writersforge.catalan.layout.AbstractLayoutEngine
Returns the free space in the current layout region.
getFreeSpace() - Method in interface org.writersforge.catalan.layout.LayoutEngine
Returns the free space in the current layout region.
getHAlign() - Method in interface org.writersforge.catalan.layout.style.AlignStyle
Returns the horizontal alignment property of the style.
getHAlign() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper
Returns the horizontal alignment property of the style.
getHAlign() - Method in class org.writersforge.catalan.layout.style.DefaultStyle
Returns the horizontal alignment property of the style.
getHAlign() - Method in class org.writersforge.catalan.layout.style.StyleChain
Returns the horizontal alignment property of the style.
getHeight() - Method in class org.writersforge.catalan.layout.LayoutArea
Getter for property height, the final calculated height to render this area.
getHeight() - Method in class org.writersforge.catalan.layout.Page
Getter for property height, the height of the Page in font points.
getHint() - Method in class org.writersforge.catalan.layout.LayoutArea
Getter for property hint, an optional field for descriptive info.
getIncludeDelimiters() - Method in class org.writersforge.catalan.process.workers.text.TextProperties
Retrieves the value of the "include-delimiters" property.
getIndent() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper
Returns the left indent spacing of this area.
getIndent() - Method in class org.writersforge.catalan.layout.style.DefaultStyle
Returns the left indent spacing of this area.
getIndent() - Method in interface org.writersforge.catalan.layout.style.InsetStyle
Returns the left indent spacing of this area.
getIndent() - Method in class org.writersforge.catalan.layout.style.StyleChain
Returns the left indent spacing of this area.
getInputStream() - Method in class org.writersforge.catalan.transform.io.IOAdapter
Converts the wrapped object into an InputStream object.
getInsets() - Method in class org.writersforge.catalan.layout.Page
Getter for property insets, the unwritable margins for this Page.
getInsets() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper
Returns an Insets object set to the values of all four InsetStyle properties, indent, rightIndent, spaceBefore, and spaceAfter.
getInsets() - Method in class org.writersforge.catalan.layout.style.DefaultStyle
Returns an Insets object set to the values of all four InsetStyle properties, indent, rightIndent, spaceBefore, and spaceAfter.
getInsets() - Method in interface org.writersforge.catalan.layout.style.InsetStyle
Returns an Insets object set to the values of all four InsetStyle properties, indent, rightIndent, spaceBefore, and spaceAfter.
getInsets() - Method in class org.writersforge.catalan.layout.style.StyleChain
Returns an Insets object set to the values of all four InsetStyle properties, indent, rightIndent, spaceBefore, and spaceAfter.
getIntersects() - Method in class org.writersforge.catalan.layout.StyledText.Span
Getter for property intersects, all Markup objects that overlap this Span.
getJavaClass() - Method in class org.writersforge.catalan.process.workers.sql.TypeMap
Retrieves the Java Class object that corresponds to this Java type.
getJavaType() - Method in class org.writersforge.catalan.process.workers.sql.Field
Retrieves the Java data type for this field.
getJavaType() - Method in class org.writersforge.catalan.process.workers.sql.TypeMap
Retrieves the Java type.
getJavaType() - Method in class org.writersforge.catalan.transform.text.SqlTable.Field
Retrieves the Java data type for this field.
getKeepOriginal() - Method in class org.writersforge.catalan.process.workers.io.IoProperties
Retrieves the value of the "keep-original" property.
getKeepOriginal() - Method in class org.writersforge.catalan.process.workers.xml.XmlCommonProperties
Retrieves the value of the "keep-original" property.
getLargest() - Method in class org.writersforge.catalan.layout.Constraint
Getter for property largest, the maximum size an area can be.
getLayout() - Method in class org.writersforge.catalan.templates.RenderTemplate
Retrieves the current LayoutEngine
getLeading() - Method in class org.writersforge.catalan.layout.style.FontStyleMetrics
Returns the leading for this font.
getLeftovers() - Method in class org.writersforge.catalan.transform.BaseNodeProcessor
Retrieves the current list of unprocessed input nodes.
getLegalTypes() - Method in class org.writersforge.catalan.process.workers.PropertyInfo
Retrieves the legal types that this property is allowed to support.
getMakeCopy() - Method in class org.writersforge.catalan.process.workers.xml.XmlCommonProperties
Retrieves the value of the "make-copy" property.
getMap() - Method in class org.writersforge.catalan.process.queue.DefaultNamedQueue
Retrieves the key/value Map of all named nodes in the INamedQueue.
getMap() - Method in interface org.writersforge.catalan.process.queue.INamedQueue
Retrieves the key/value Map of all named nodes in the INamedQueue.
getMarkup() - Method in class org.writersforge.catalan.layout.StyledText
Getter for property markup.
getMatch() - Method in class org.writersforge.catalan.templates.generic.IfOp
Returns the 'match' property of the op, or "" if 'match' is not specified.
getMaximum() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper
Returns the maximum geometrical extents of this area.
getMaximum() - Method in class org.writersforge.catalan.layout.style.DefaultStyle
Returns the maximum geometrical extents of this area.
getMaximum() - Method in interface org.writersforge.catalan.layout.style.ExtentStyle
Returns the maximum geometrical extents of this area.
getMaximum() - Method in class org.writersforge.catalan.layout.style.StyleChain
Returns the maximum geometrical extents of this area.
getMessage() - Method in class org.writersforge.catalan.process.queue.Alert
Retrieves the optional text content of the alert.
getMetadata() - Method in class org.writersforge.catalan.process.workers.BaseMetadataHolder
Retrieves metadata associated with this object.
getMetadata() - Method in interface org.writersforge.catalan.process.workers.IMetadataHolder
Retrieves metadata associated with this object.
getMetadata() - Method in class org.writersforge.catalan.process.workers.XmlJob
Retrieves descriptive metadata associated with this job implementation.
getMinimum() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper
Returns the minimum geometrical extents of this area.
getMinimum() - Method in class org.writersforge.catalan.layout.style.DefaultStyle
Returns the minimum geometrical extents of this area.
getMinimum() - Method in interface org.writersforge.catalan.layout.style.ExtentStyle
Returns the minimum geometrical extents of this area.
getMinimum() - Method in class org.writersforge.catalan.layout.style.StyleChain
Returns the minimum geometrical extents of this area.
getName() - Method in class org.writersforge.catalan.process.queue.AlertPriority
Retrieves the text name of the priority.
getName() - Method in class org.writersforge.catalan.process.workers.DefaultWorkerInfo
Retrieves the official name of this worker or command.
getName() - Method in interface org.writersforge.catalan.process.workers.IWorkMetadata
Retrieves the name of this worker or command.
getName() - Method in class org.writersforge.catalan.process.workers.PropertyInfo
Retrieves the name of the command.
getName() - Method in class org.writersforge.catalan.process.workers.WorkMetadata
Retrieves the name of the associated object.
getName() - Method in class org.writersforge.catalan.process.workers.sql.Field
Retrieves the name of this field.
getName() - Method in class org.writersforge.catalan.process.workers.sql.SqlTable
Retrieves the name of the table.
getName() - Method in class org.writersforge.catalan.process.workers.xml.DirectiveStack.Attribute
Retrieves the name property of this Attribute directive.
getName() - Method in class org.writersforge.catalan.transform.text.SqlTable.Field
Retrieves the name of this field.
getName() - Method in class org.writersforge.catalan.transform.text.SqlTable
Retrieves the name of the table.
getName() - Method in class org.writersforge.catalan.transform.xml.DirectiveStack.Attribute
Retrieves the name property of this Attribute directive.
getNameProperty() - Method in class org.writersforge.catalan.process.workers.sql.Field
Retrieves the name of this field as a PropertyName object.
getNameProperty() - Method in class org.writersforge.catalan.process.workers.sql.SqlTable
Retrieves the name of the table as a PropertyName object.
getNameProperty() - Method in class org.writersforge.catalan.transform.text.SqlTable.Field
Retrieves the name of this field as a PropertyName object.
getNameProperty() - Method in class org.writersforge.catalan.transform.text.SqlTable
Retrieves the name of the table as a PropertyName object.
getNamedArg(String) - Method in class org.writersforge.catalan.util.CommandArgs
Retrieves the value of the named argument, or null if the argument does not exist.
getNamedArgs() - Method in class org.writersforge.catalan.util.CommandArgs
Retrieves a Map of named arguments, i.e., matched pairs of arguments consisting of an argument name prefixed by "-" or "--" and the following value of that argument.
getNewName() - Method in class org.writersforge.catalan.process.workers.xml.XmlCommonProperties
Retrieves the value of the "new-name" property.
getNewText() - Method in class org.writersforge.catalan.process.workers.text.TextProperties
Retrieves the value of the "newtext" property.
getNextDirective(Object) - Method in class org.writersforge.catalan.process.workers.xml.DirectiveStack
Retrieves the next Directive in the stack.
getNextDirective(Object) - Method in class org.writersforge.catalan.transform.xml.DirectiveStack
Retrieves the next Directive in the stack.
getNodeSelection() - Method in class org.writersforge.catalan.process.workers.queue.QueueProperties
Retrieves the value of the "nodes" property.
getNodes() - Method in class org.writersforge.catalan.process.queue.DefaultNamedQueue
Retrieves the current node processing list.
getNodes() - Method in class org.writersforge.catalan.process.queue.DefaultQueue
Retrieves the current node processing list.
getNodes() - Method in interface org.writersforge.catalan.process.queue.IQueue
Retrieves the current node processing list.
getNodes() - Method in class org.writersforge.catalan.transform.BaseNodeProcessor
Retrieves the current node processing list.
getNormalizeExclusions() - Method in class org.writersforge.catalan.process.workers.text.TextProperties
Retrieves the value of the "exclusions" property for the normalize command.
getNormalizeResolver() - Method in class org.writersforge.catalan.process.workers.text.TextProperties
Retrieves the value of the "resolver" property.
getNormalizeTokens() - Method in class org.writersforge.catalan.process.workers.text.TextProperties
Retrieves the value of the "tokens" property for the normalize command.
getOldText() - Method in class org.writersforge.catalan.process.workers.text.TextProperties
Retrieves the value of the "oldtext" property.
getOp() - Method in class org.writersforge.catalan.templates.generic.GenericOp
Returns the encapsulated Datum op.
getOpType() - Method in class org.writersforge.catalan.templates.generic.GenericOp
Returns the element name of this op.
getOptionalProperties() - Method in class org.writersforge.catalan.process.workers.DefaultWorkerInfo
Retrieves metadata for all optional properties for this worker.
getOptionalProperties() - Method in interface org.writersforge.catalan.process.workers.IWorkMetadata
Retrieves metadata for all optional properties for this worker or command.
getOptionalProperties() - Method in class org.writersforge.catalan.process.workers.WorkMetadata
Retrieves metadata for all optional properties for th for the associated object.
getOrientation() - Method in class org.writersforge.catalan.layout.LayoutGroup
Getter for property orientation, flow orientation of the children in this group
getOuterRegion() - Method in class org.writersforge.catalan.layout.LayoutContext
Retrieves the the top-level layout region.
getOutput() - Method in class org.writersforge.catalan.process.workers.io.IoProperties
Retrieves the value of the "output" property.
getOutputStream() - Method in class org.writersforge.catalan.transform.io.IOAdapter
Converts the wrapped object into an OutputStream object.
getPadding() - Method in class org.writersforge.catalan.process.workers.text.TextProperties
Retrieves the value of the "padding" property.
getPage(int) - Method in class org.writersforge.catalan.layout.Book
Gets a single processed page.
getPages() - Method in class org.writersforge.catalan.layout.Book
Gets the array of processed pages.
getParameter(char) - Method in class org.writersforge.catalan.templates.generic.GenericOp
Returns the value of a numbered parameter; used for parameterized queries.
getParams() - Method in class org.writersforge.catalan.util.CommandArgs
Retrieves all unnamed arguments.
getPartitions() - Method in class org.writersforge.catalan.process.workers.partition.PartitionProperties
Retrieves the value of the "partitions" property.
getPaths() - Method in class org.writersforge.catalan.process.workers.xml.XmlCommonProperties
Retrieves the value of the "paths" property.
getPcdata() - Method in class org.writersforge.catalan.process.workers.velocity.DatumAdapter
Retrieves all the PCDATA content of the wrapped Datum node and its children.
getPcdata(boolean) - Method in class org.writersforge.catalan.process.workers.velocity.DatumAdapter
Retrieves all the PCDATA content of the wrapped Datum node and its children with the specified whitespace behavior.
getPcdata() - Method in class org.writersforge.catalan.transform.external.DatumAdapter
Retrieves all the PCDATA content of the wrapped Datum node and its children.
getPcdata(boolean) - Method in class org.writersforge.catalan.transform.external.DatumAdapter
Retrieves all the PCDATA content of the wrapped Datum node and its children with the specified whitespace behavior.
getPosition() - Method in class org.writersforge.catalan.process.workers.queue.QueueProperties
Retrieves the value of the "pos" property.
getPosition(int) - Method in class org.writersforge.catalan.process.workers.queue.QueueProperties
Retrieves the value of the "pos" property, as a real queue index.
getPosition() - Method in class org.writersforge.catalan.process.workers.xml.XmlCommonProperties
Retrieves the value of the "position" property.
getPreferred() - Method in class org.writersforge.catalan.layout.Constraint
Getter for property preferred, the optimal size an area can be.
getPreferred() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper
Returns the preferred geometrical extents of this area.
getPreferred() - Method in class org.writersforge.catalan.layout.style.DefaultStyle
Returns the preferred geometrical extents of this area.
getPreferred() - Method in interface org.writersforge.catalan.layout.style.ExtentStyle
Returns the preferred geometrical extents of this area.
getPreferred() - Method in class org.writersforge.catalan.layout.style.StyleChain
Returns the preferred geometrical extents of this area.
getPrimaryKeys() - Method in class org.writersforge.catalan.process.workers.sql.SqlTable
Retrieves an array of all primary key fields in this table.
getPrimaryKeys() - Method in class org.writersforge.catalan.transform.text.SqlTable
Retrieves an array of all primary key fields in this table.
getPriority() - Method in class org.writersforge.catalan.process.queue.Alert
Retrieves the priority of the alert.
getProcessorIds() - Method in class org.writersforge.catalan.transform.Transformer
Deprecated. Retrieves an array of unique identifiers for all NodeProcessors in this Transformer.
getProperties() - Method in class org.writersforge.catalan.process.queue.DefaultNamedQueue
Retrieves the container for all properties currently set in the workspace.
getProperties() - Method in class org.writersforge.catalan.process.queue.DefaultQueue
Retrieves the container for all properties currently set in the workspace.
getProperties() - Method in interface org.writersforge.catalan.process.workers.IPropertyHolder
Retrieves all properties currently set in this container.
getProperties() - Method in class org.writersforge.catalan.process.workspace.XmlWorkspace
Retrieves the container for all properties currently set in the workspace.
getProperty(String) - Method in class org.writersforge.catalan.layout.Book
Returns the value of a generic property.
getProperty(String) - Method in class org.writersforge.catalan.process.properties.ChainedProperties
Retrieves the value of a named config property from the chained IWorkProperties instances.
getProperty(String) - Method in class org.writersforge.catalan.process.properties.EmptyProperties
Retrieves the value of a named config property.
getProperty(String) - Method in interface org.writersforge.catalan.process.properties.IWorkProperties
Retrieves the value of a named property.
getProperty(String) - Method in class org.writersforge.catalan.process.properties.MapProperties
Retrieves the value of a named config property from the embedded Map.
getProperty(String) - Method in class org.writersforge.catalan.process.properties.XmlProperties
Retrieves the value of a named config property.
getProperty(String) - Method in class org.writersforge.catalan.process.workers.velocity.DatumAdapter
Retrieves a Datum property value from the root node as a PropertyName object.
getProperty() - Method in class org.writersforge.catalan.templates.generic.TextOp
Returns the 'property' property of the op, or null if 'property' is not specified.
getProperty(String) - Method in class org.writersforge.catalan.transform.external.DatumAdapter
Retrieves a Datum property value from the root node as a PropertyName object.
getPropertyAsBoolean(String, boolean) - Method in class org.writersforge.catalan.process.properties.BaseWorkProperties
Retrieves the named property as a boolean; if the property exists but cannot be converted into a boolean, returns the default.
getPropertyAsBoolean(String, boolean) - Method in interface org.writersforge.catalan.process.properties.IWorkProperties
Retrieves the named property as a boolean; if the property exists but cannot be converted into a boolean, returns the default.
getPropertyAsDatum(String, Datum) - Method in class org.writersforge.catalan.process.properties.BaseWorkProperties
Retrieves the named property as a Datum; if the property cannot be converted into a Datum, returns the default.
getPropertyAsDatum(String, Datum) - Method in interface org.writersforge.catalan.process.properties.IWorkProperties
Retrieves the named property as a Datum; if the property cannot be converted into a Datum, returns the default.
getPropertyAsMap(String, Map) - Method in class org.writersforge.catalan.process.properties.BaseWorkProperties
Retrieves the named property as a Map; if the property cannot be converted into a Map, returns the default.
getPropertyAsMap(String, Map) - Method in interface org.writersforge.catalan.process.properties.IWorkProperties
Retrieves the named property as a Map; if the property cannot be converted into a Map, returns the default.
getPropertyAsNumber(String, Number) - Method in class org.writersforge.catalan.process.properties.BaseWorkProperties
Retrieves the named property as an Number; if the property exists but cannot be converted into an Number, returns the default.
getPropertyAsNumber(String, Number) - Method in interface org.writersforge.catalan.process.properties.IWorkProperties
Retrieves the named property as an Number; if the property exists but cannot be converted into an Number, returns the default.
getPropertyAsString(String, String) - Method in class org.writersforge.catalan.process.properties.BaseWorkProperties
Retrieves the named property as a String; if the property is not already a String, calls toString() on it before returning it.
getPropertyAsString(String, String) - Method in interface org.writersforge.catalan.process.properties.IWorkProperties
Retrieves the named property as a String; if the property is not already a String, calls toString() on it before returning it.
getPropertyName() - Method in class org.writersforge.catalan.process.workers.queue.QueueProperties
Retrieves the value of the "property-name" property.
getPropertyNames() - Method in class org.writersforge.catalan.process.properties.ChainedProperties
Retrieves the names of all properties currently set on this holder.
getPropertyNames() - Method in class org.writersforge.catalan.process.properties.EmptyProperties
Retrieves the names of all properties currently set on this holder.
getPropertyNames() - Method in interface org.writersforge.catalan.process.properties.IWorkProperties
Retrieves the names of all properties currently set on this holder.
getPropertyNames() - Method in class org.writersforge.catalan.process.properties.MapProperties
Retrieves the names of all properties currently set on this holder.
getPropertyNames() - Method in class org.writersforge.catalan.process.properties.XmlProperties
Retrieves the names of all properties currently set on this holder.
getPropertySets() - Method in class org.writersforge.catalan.process.properties.ChainedProperties
Retrieves an array of all chained IWorkProperties instances.
getQueries() - Method in class org.writersforge.catalan.process.workers.xml.XmlCommonProperties
Retrieves the value of the "queries" property.
getQuery() - Method in class org.writersforge.catalan.process.workers.xml.XmlCommonProperties
Retrieves the value of the "query" property.
getQuery() - Method in class org.writersforge.catalan.transform.xform.XFormProcessor
Retrieves the Bellows query path to select nodes to process.
getQueryNodes(Datum, XmlCommonProperties) - Method in class org.writersforge.catalan.process.workers.xml.BaseQueryCommand
Retrieves the XML elements declared in the "query" property.
getQueryNodes(Datum) - Method in class org.writersforge.catalan.transform.xform.XFormProcessor
Finds the Datum nodes to perform the transformation on.
getQueue(String) - Method in class org.writersforge.catalan.process.queue.QueueManager
Retrieves the named IQueue object, or null if queue does not exist.
getQueue() - Method in class org.writersforge.catalan.process.workers.queue.QueueProperties
Retrieves the value of the "queue" property.
getQueueNames() - Method in class org.writersforge.catalan.process.queue.QueueManager
Retrieves the names of all queues.
getQueueSize() - Method in class org.writersforge.catalan.layout.AbstractLayoutEngine
Returns the number of areas currently in the layout queue.
getQueueSize() - Method in interface org.writersforge.catalan.layout.LayoutEngine
Returns the number of areas currently in the layout queue.
getQueues() - Method in class org.writersforge.catalan.process.queue.QueueManager
Retrieves all IQueue objects.
getRawArgs() - Method in class org.writersforge.catalan.util.CommandArgs
Retrieves the full original array of command-line arguments.
getReader() - Method in class org.writersforge.catalan.transform.io.IOAdapter
Converts the wrapped object into a Reader object.
getRegion(String) - Method in class org.writersforge.catalan.templates.Section
Returns a Rectangle that defines the bounding area for the named region.
getRegionExtents(String) - Method in interface org.writersforge.catalan.templates.RegionMap
Returns the geometrical extents of the named region.
getRegionExtents(String) - Method in class org.writersforge.catalan.templates.generic.GenericRegionMap
Returns the geometrical extents of the named region.
getRegionMap() - Method in class org.writersforge.catalan.templates.Section
Getter for property regionMap.
getRegionNames() - Method in interface org.writersforge.catalan.templates.RegionMap
Returns an array of all valid region names in this map.
getRegionNames() - Method in class org.writersforge.catalan.templates.Section
Returns an array of all region names in this section which have flow and/or static content.
getRegionNames() - Method in class org.writersforge.catalan.templates.generic.GenericRegionMap
Returns an array of all valid region names in this map.
getRelations(int) - Method in class org.writersforge.catalan.layout.Constraint
Indexed getter for property relations.
getRelations() - Method in class org.writersforge.catalan.layout.Constraint
Getter for property relations.
getRenderableExtents() - Method in class org.writersforge.catalan.layout.LayoutArea
Retrieves a Rectangle of the valid rendering extents for this area, the normal extents minus the insets.
getRequiredProperties() - Method in class org.writersforge.catalan.process.workers.DefaultWorkerInfo
Retrieves metadata for all required properties for this worker.
getRequiredProperties() - Method in interface org.writersforge.catalan.process.workers.IWorkMetadata
Retrieves metadata for all required properties for this worker or command.
getRequiredProperties() - Method in class org.writersforge.catalan.process.workers.WorkMetadata
Retrieves metadata for all required properties for the associated object If no required properties exist, returns an empty array.
getResolverMap() - Method in class org.writersforge.catalan.process.workers.text.TextProperties
Retrieves the value of the "lookup" property.
getRightIndent() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper
Returns the right indent spacing of this area.
getRightIndent() - Method in class org.writersforge.catalan.layout.style.DefaultStyle
Returns the right indent spacing of this area.
getRightIndent() - Method in interface org.writersforge.catalan.layout.style.InsetStyle
Returns the right indent spacing of this area.
getRightIndent() - Method in class org.writersforge.catalan.layout.style.StyleChain
Returns the right indent spacing of this area.
getRoot() - Method in class org.writersforge.catalan.process.workers.velocity.DatumAdapter
Retrieves the root of the wrapped Datum tree.
getRoot() - Method in class org.writersforge.catalan.transform.external.DatumAdapter
Retrieves the root of the wrapped Datum tree.
getRowFlowSelect() - Method in class org.writersforge.catalan.templates.generic.TableOp
Returns the 'select' property for the <row-flow> op, or an empty string if 'select' is not specified.
getRowHeaderSelect() - Method in class org.writersforge.catalan.templates.generic.TableOp
Returns the 'select' property for the <row-headers> op, or an empty string if 'select' is not specified.
getRuntimeProperties() - Method in class org.writersforge.catalan.process.workers.BaseWorker
Retrieves this IWorker's default and runtime properties.
getRuntimeProps() - Method in class org.writersforge.catalan.process.commands.CommandContext
Retrieves the runtime properties that the command should use.
getSafePcdata() - Method in class org.writersforge.catalan.process.workers.velocity.DatumAdapter
Retrieves a Java String-safe version of the PCDATA content in the wrapped Datum node.
getSafePcdata() - Method in class org.writersforge.catalan.transform.external.DatumAdapter
Retrieves a Java String-safe version of the PCDATA content in the wrapped Datum node.
getSections() - Method in class org.writersforge.catalan.templates.GenericTemplate
Returns an array of all Section objects associated with this template.
getSections() - Method in class org.writersforge.catalan.templates.RenderTemplate
Returns an array of all Section objects associated with this template.
getSelect() - Method in class org.writersforge.catalan.templates.generic.ForEachOp
Returns the 'select' property of the op, or "" if 'select' is not specified.
getSelect() - Method in class org.writersforge.catalan.templates.generic.TextOp
Returns the 'select' property of the op, or "" if 'select' is not specified.
getSeparator() - Method in class org.writersforge.catalan.process.workers.text.TextProperties
Retrieves the value of the "separator" property.
getSeparator() - Method in class org.writersforge.catalan.process.workers.xml.XmlCommonProperties
Retrieves the value of the "separator" property.
getSmallest() - Method in class org.writersforge.catalan.layout.Constraint
Getter for property smallest, the minimum size an area can be.
getSpaceAfter() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper
Returns the bottom indent spacing of this area.
getSpaceAfter() - Method in class org.writersforge.catalan.layout.style.DefaultStyle
Returns the bottom indent spacing of this area.
getSpaceAfter() - Method in interface org.writersforge.catalan.layout.style.InsetStyle
Returns the bottom indent spacing of this area.
getSpaceAfter() - Method in class org.writersforge.catalan.layout.style.StyleChain
Returns the bottom indent spacing of this area.
getSpaceBefore() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper
Returns the top indent spacing of this area.
getSpaceBefore() - Method in class org.writersforge.catalan.layout.style.DefaultStyle
Returns the top indent spacing of this area.
getSpaceBefore() - Method in interface org.writersforge.catalan.layout.style.InsetStyle
Returns the top indent spacing of this area.
getSpaceBefore() - Method in class org.writersforge.catalan.layout.style.StyleChain
Returns the top indent spacing of this area.
getSpans() - Method in class org.writersforge.catalan.layout.StyledText
Returns an array of text spans that delimit all changes in text style, i.e., a list of discrete markup regions.
getSqlType() - Method in class org.writersforge.catalan.process.workers.sql.Field
Retrieves the SQL data type for this field.
getSqlType() - Method in class org.writersforge.catalan.process.workers.sql.TypeMap
Retrieves the SQL type.
getSqlType() - Method in class org.writersforge.catalan.transform.text.SqlTable.Field
Retrieves the SQL data type for this field.
getStack() - Method in class org.writersforge.catalan.process.workers.xml.DirectiveStack.Repeat
Retrieves the embedded stack.
getStack() - Method in class org.writersforge.catalan.process.workers.xml.XmlCommonProperties
Retrieves the value of the "stack" property.
getStack() - Method in class org.writersforge.catalan.transform.xml.DirectiveStack.Repeat
Retrieves the embedded stack.
getStackCount() - Method in class org.writersforge.catalan.layout.LayoutContext
Returns the number of unhandled areas left in the queue.
getStart() - Method in class org.writersforge.catalan.layout.Markup
Getter for property start, the index of the first text character in the style span.
getStart() - Method in class org.writersforge.catalan.layout.StyledText.Span
Getter for property start, the index of the first text character in the style span.
getStart() - Method in class org.writersforge.catalan.process.workers.partition.Partition
Retrieves the starting pattern for this parition.
getStartIndex(int) - Method in class org.writersforge.catalan.process.properties.CommonProperties
Retrieves the value of the "start-index" property.
getStartIndex() - Method in class org.writersforge.catalan.process.workers.partition.PartitionRange
Retrieves the starting index of this partition.
getStartTagIndex() - Method in class org.writersforge.catalan.process.workers.xml.XmlCommonProperties
Retrieves the value of the "start-tag-index" property.
getStartToken() - Method in class org.writersforge.catalan.process.workers.text.TextProperties
Retrieves the value of the "start-token" property.
getStaticTemplate(String) - Method in class org.writersforge.catalan.templates.Section
Returns a Datum object that embodies the static template for the named region.
getStrictWhitespace() - Method in class org.writersforge.catalan.process.workers.io.IoProperties
Retrieves the value of the "strict-whitespace" property.
getStyle() - Method in class org.writersforge.catalan.layout.LayoutArea
Getter for property style, the layout constraints set up by the template for this area.
getStyle() - Method in class org.writersforge.catalan.layout.Markup
Getter for property style, the font for this markup section.
getStyle() - Method in class org.writersforge.catalan.process.workers.javabean.JavaBeanProperties
Retrieves the value of the "style" property.
getStyle() - Method in class org.writersforge.catalan.process.workers.xml.XmlCommonProperties
Retrieves the value of the "style" property.
getStyleMap() - Method in class org.writersforge.catalan.templates.generic.GenericOp
Returns the StyleMap for this op.
getStyledText() - Method in class org.writersforge.catalan.layout.LayoutText
Getter for property styledText, the multi-style text content of this area.
getSwallowUndefined() - Method in class org.writersforge.catalan.process.workers.text.TextProperties
Retrieves the value of the "swallow-undefined" property.
getTagAttribute() - Method in class org.writersforge.catalan.process.workers.xml.XmlCommonProperties
Retrieves the value of the "attribute" property for the "tag" command.
getTarget() - Method in class org.writersforge.catalan.layout.Relation
Getter for property target, the LayoutArea (attractor) to bind to.
getTemplate() - Method in class org.writersforge.catalan.process.workers.velocity.VelocityProperties
Retrieves the value of the "template" property.
getText() - Method in class org.writersforge.catalan.layout.LayoutText
Getter for property text, the raw text content of this area.
getText() - Method in class org.writersforge.catalan.layout.StyledText
Returns a plain text version of the text contents.
getText() - Method in class org.writersforge.catalan.templates.generic.LiteralOp
Retrieves the PCDATA text content from the current literal op.
getText() - Method in class org.writersforge.catalan.util.TransformTask.Input
Retrieves PCDATA element content.
getTextHeight(int) - Method in class org.writersforge.catalan.layout.StyledText
Calculates the vertical extents of the entire run of text, if the text were wrapped to the given width.
getTextLength() - Method in class org.writersforge.catalan.layout.StyledText
Returns the total count of text characters.
getTextStyle() - Method in class org.writersforge.catalan.layout.StyledText
Returns the text style of this object
getTextStyle(String) - Method in class org.writersforge.catalan.layout.style.DatumStyleMap
Returns the named text style from this map.
getTextStyle(String) - Method in class org.writersforge.catalan.layout.style.DefaultStyle
Returns the named text style from this map.
getTextStyle(String) - Method in interface org.writersforge.catalan.layout.style.StyleMap
Returns the named text style from this map.
getTextStyles() - Method in class org.writersforge.catalan.layout.style.StyleChain
Returns an array of all TextStyle objects in this chain.
getType() - Method in class org.writersforge.catalan.process.workers.partition.Partition
Retrieves the type name of this parition.
getType() - Method in class org.writersforge.catalan.process.workers.partition.PartitionRange
Retrieves the partition type name.
getType() - Method in class org.writersforge.catalan.process.workers.velocity.DatumAdapter
Retrieves element type of root node as a PropertyName object.
getType() - Method in class org.writersforge.catalan.transform.external.DatumAdapter
Retrieves element type of root node as a PropertyName object.
getTypeMap() - Method in class org.writersforge.catalan.process.workers.sql.SqlProperties
Retrieves the value of the "type-map" property.
getUsePrimitives() - Method in class org.writersforge.catalan.process.workers.sql.SqlProperties
Retrieves the value of the "use-primitives" property.
getVAlign() - Method in interface org.writersforge.catalan.layout.style.AlignStyle
Returns the vertical alignment property of the style.
getVAlign() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper
Returns the vertical alignment property of the style.
getVAlign() - Method in class org.writersforge.catalan.layout.style.DefaultStyle
Returns the vertical alignment property of the style.
getVAlign() - Method in class org.writersforge.catalan.layout.style.StyleChain
Returns the vertical alignment property of the style.
getValue() - Method in class org.writersforge.catalan.process.queue.AlertPriority
Retrieves the numeric value of the priority.
getValue() - Method in class org.writersforge.catalan.process.workers.xml.DirectiveStack.Directive
Retrieves the static value of this directive.
getValue() - Method in class org.writersforge.catalan.transform.xml.DirectiveStack.Directive
Retrieves the static value of this directive.
getWeight() - Method in class org.writersforge.catalan.layout.Relation
Getter for property weight, how important this relationship is.
getWidth() - Method in class org.writersforge.catalan.layout.LayoutArea
Getter for property width, the final calculated width to render this area.
getWidth() - Method in class org.writersforge.catalan.layout.Page
Getter for property width, the width of the Page in font points.
getWorker(String) - Method in class org.writersforge.catalan.process.workers.WorkerRegistry
Retrieves the named IWorker object from the registry.
getWorkerNames() - Method in class org.writersforge.catalan.process.workers.WorkerRegistry
Retrieves an array of all IWorker names in this registry.
getWorkerRegistry() - Method in interface org.writersforge.catalan.process.workspace.IWorkspace
Retrieves the WorkerRegistry for this IWorkspace.
getWorkerRegistry() - Method in class org.writersforge.catalan.process.workspace.XmlWorkspace
Retrieves the WorkerRegistry for this IWorkspace.
getWorkerRuntimeProperties() - Method in class org.writersforge.catalan.process.workers.BaseJob
Retrieves customized runtime properties for each IWorker returned in getWorkers().
getWorkerRuntimeProperties() - Method in class org.writersforge.catalan.process.workers.XmlJob
Retrieves customized runtime properties for each IWorker returned in getWorkers().
getWorkers() - Method in class org.writersforge.catalan.process.workers.BaseJob
Retrieves all embedded Workers associated with this BaseJob, in the order they will run for this BaseJob.
getWorkers() - Method in class org.writersforge.catalan.process.workers.XmlJob
Retrieves all embedded Workers associated with this BaseJob, in the order they will run for this BaseJob.
getWorkers() - Method in class org.writersforge.catalan.process.workers.partition.Partition
Retrieves embedded XML workers.
getWorkspace() - Method in class org.writersforge.catalan.process.WorkProcessor
Retrieves this WorkProcessor's workspace.
getWorkspace() - Method in class org.writersforge.catalan.process.commands.CommandContext
Retrieves the workspace that the command should use.
getWorkspace() - Method in class org.writersforge.catalan.process.workers.BaseWorker
Retrieves current IWorkspace if inside the process() method, or null if outside.
getWrap() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper
Returns the wrap style of this text, according to the WRAP_xxx enumeration.
getWrap() - Method in class org.writersforge.catalan.layout.style.DefaultStyle
Returns the wrap style of this text, according to the WRAP_xxx enumeration.
getWrap() - Method in class org.writersforge.catalan.layout.style.StyleChain
Returns the wrap style of this text, according to the WRAP_xxx enumeration.
getWrap() - Method in interface org.writersforge.catalan.layout.style.TextStyle
Returns the wrap style of this text, according to the WRAP_xxx enumeration.
getWrapper() - Method in class org.writersforge.catalan.process.workers.xml.XmlCommonProperties
Retrieves the value of the "wrapper" property.
getWriter() - Method in class org.writersforge.catalan.transform.io.IOAdapter
Converts the wrapped object into a Writer object.
getX() - Method in class org.writersforge.catalan.layout.LayoutArea
Getter for property x, the final calculated x-axis origin to render this area.
getY() - Method in class org.writersforge.catalan.layout.LayoutArea
Getter for property y, the final calculated y-axis origin to render this area.
guessSize(LayoutArea) - Method in class org.writersforge.catalan.layout.AbstractLayoutEngine
Estimates the size that the area "wants" to be.
guessSize(LayoutArea) - Method in interface org.writersforge.catalan.layout.LayoutEngine
Estimates the size that the area "wants" to be.
guessSize(LayoutArea) - Method in class org.writersforge.catalan.layout.SimpleFlowLayout
Estimates the size that the area "wants" to be.

H

HEAVY_WEIGHT - Static variable in class org.writersforge.catalan.layout.Relation
Very important Relation, only override if critical
HORIZONTAL - Static variable in class org.writersforge.catalan.layout.LayoutGroup
Group child areas in a horizontal direction
HORIZONTAL_MASK - Static variable in class org.writersforge.catalan.layout.Relation
Apply relation along horizontal axis
HibernateCodeGenerator - class org.writersforge.catalan.process.HibernateCodeGenerator.
A CodeGenerator specializing in creating Hibernate bindings from SQL DDL definitions.
HibernateCodeGenerator(String[]) - Constructor for class org.writersforge.catalan.process.HibernateCodeGenerator
Creates a new instance of HibernateCodeGenerator.
HtmlRenderer - class org.writersforge.catalan.renderers.HtmlRenderer.
Generates a collection of HTML files from one or more Page objects created by a RenderTemplate class.
HtmlRenderer() - Constructor for class org.writersforge.catalan.renderers.HtmlRenderer
 
HtmlWorker - class org.writersforge.catalan.process.workers.html.HtmlWorker.
IWorker implementation which provides support for HTML generation and parsing.
HtmlWorker() - Constructor for class org.writersforge.catalan.process.workers.html.HtmlWorker
 
handleErrorProblem(String, ProcessException) - Method in class org.writersforge.catalan.process.workers.BaseWorker
Handles an ERROR problem; might throw the exception or post it as an Alert in the AlertQueue, or both, depending on the config of the IWorker.
handleFatalProblem(String, ProcessException) - Method in class org.writersforge.catalan.process.workers.BaseWorker
Handles a FATAL problem; might throw the exception or post it as an Alert in the AlertQueue, or both, depending on the config of the IWorker.
handleInfoProblem(String, ProcessException) - Method in class org.writersforge.catalan.process.workers.BaseWorker
Handles an INFO problem; might throw the exception or post it as an Alert in the AlertQueue, or both, depending on the config of the IWorker.
handleProcessException(ProcessException) - Method in class org.writersforge.catalan.process.WorkProcessor
Handles the processing exception.
handleWarningProblem(String, ProcessException) - Method in class org.writersforge.catalan.process.workers.BaseWorker
Handles a WARNING problem; might throw the exception or post it as an Alert in the AlertQueue, or both, depending on the config of the IWorker.

I

ICommand - interface org.writersforge.catalan.process.commands.ICommand.
Encapsulation of a specific, smaller action inside the context of a worker.
IFragmentFilter - interface org.writersforge.catalan.text.fragfilters.IFragmentFilter.
General interface for processing an array of text fragments as a whole.
IMetadataHolder - interface org.writersforge.catalan.process.workers.IMetadataHolder.
Interface for accessing an object's metadata.
INDENT_MASK - Static variable in class org.writersforge.catalan.layout.Relation
Horizontally indented to the left of the attractor (can be negative for indentation to the right)
INFO - Static variable in class org.writersforge.catalan.process.queue.AlertPriority
An INFO Alert, signalling that the transform succeeded but wanted to report status to the calling application; can be used for debugging.
INamedQueue - interface org.writersforge.catalan.process.queue.INamedQueue.
A IQueue that holds named properties; an INamedQueue should wrap a Map collection.
IOAdapter - class org.writersforge.catalan.process.workers.io.IOAdapter.
Convenience class for converting I/O classes from one interface to another, for example a Reader into an InputStream.
IOAdapter(Object) - Constructor for class org.writersforge.catalan.process.workers.io.IOAdapter
Creates a new instance of IOAdapter.
IOAdapter - class org.writersforge.catalan.transform.io.IOAdapter.
Convenience class for converting I/O classes from one interface to another, for example a Reader into an InputStream.
IOAdapter(Object) - Constructor for class org.writersforge.catalan.transform.io.IOAdapter
Creates a new instance of IOAdapter.
IPropertyHolder - interface org.writersforge.catalan.process.workers.IPropertyHolder.
An object which can maintain a set of named properties.
IQueue - interface org.writersforge.catalan.process.queue.IQueue.
A collection of processing nodes.
ITextExtractor - interface org.writersforge.catalan.text.extractors.ITextExtractor.
Generic interface for pulling specific fragments of text out of a text document.
ITextFilter - interface org.writersforge.catalan.text.filters.ITextFilter.
Generic interface for modifying text in place.
ITextMerger - interface org.writersforge.catalan.text.mergers.ITextMerger.
General interface for collapsing multiple text fragments into a single text document
IWorkMetadata - interface org.writersforge.catalan.process.workers.IWorkMetadata.
Metadata manager for IWorker and BaseCommandWorker implementations.
IWorkProperties - interface org.writersforge.catalan.process.properties.IWorkProperties.
Configuration information for a single IWorker.
IWorker - interface org.writersforge.catalan.process.workers.IWorker.
Fundamental interface for processing node queues.
IWorkspace - interface org.writersforge.catalan.process.workspace.IWorkspace.
Running data context for an entire processing run.
IfOp - class org.writersforge.catalan.templates.generic.IfOp.
A template op wrapper for <if> and <if-not>.
IfOp(Datum, StyleMap) - Constructor for class org.writersforge.catalan.templates.generic.IfOp
Creates a new instance of IfOp.
IfOp(Datum, StyleMap, StyleChain) - Constructor for class org.writersforge.catalan.templates.generic.IfOp
Creates a new instance of IfOp with an optional StyleChain fallback.
ImageOp - class org.writersforge.catalan.templates.generic.ImageOp.
A template op wrapper for <image>.
ImageOp(Datum, StyleMap) - Constructor for class org.writersforge.catalan.templates.generic.ImageOp
Creates a new instance of ImageOp.
ImageOp(Datum, StyleMap, StyleChain) - Constructor for class org.writersforge.catalan.templates.generic.ImageOp
Creates a new instance of ImageOp with an optional StyleChain fallback.
ImportCommand - class org.writersforge.catalan.process.workers.io.ImportCommand.
Implementation for "import" command.
ImportCommand() - Constructor for class org.writersforge.catalan.process.workers.io.ImportCommand
Creates a new instance of ImportCommand.
ImportProcessor - class org.writersforge.catalan.transform.io.ImportProcessor.
A processor which loads data from files and URLs into data nodes.
ImportProcessor(Datum) - Constructor for class org.writersforge.catalan.transform.io.ImportProcessor
Creates a new instance of ImportProcessor from the XML spec.
ImportProcessor(String, boolean, boolean) - Constructor for class org.writersforge.catalan.transform.io.ImportProcessor
Creates a new instance of ImportProcessor.
InlineProcessor - class org.writersforge.catalan.transform.xform.InlineProcessor.
A Datum-only NodeProcessor for decreasing the level of nesting for the queried set of elements.
InlineProcessor(Datum) - Constructor for class org.writersforge.catalan.transform.xform.InlineProcessor
Creates a new instance of InlineProcessor from the XML spec.
InlineProcessor(String) - Constructor for class org.writersforge.catalan.transform.xform.InlineProcessor
Creates a new instance of InlineProcessor.
InsertProcessor - class org.writersforge.catalan.transform.xform.InsertProcessor.
A Datum-only NodeProcessor for inserting static XML content into other parts of the same XML tree.
InsertProcessor(Datum) - Constructor for class org.writersforge.catalan.transform.xform.InsertProcessor
Creates a new instance of InsertProcessor from the XML spec.
InsertProcessor(String, Datum, int, boolean) - Constructor for class org.writersforge.catalan.transform.xform.InsertProcessor
Creates a new instance of InsertProcessor for element creation.
InsertProcessor(String, String, String) - Constructor for class org.writersforge.catalan.transform.xform.InsertProcessor
Creates a new instance of InsertProcessor for attribute creation.
InsetStyle - interface org.writersforge.catalan.layout.style.InsetStyle.
The border of whitespace that shouldn't be drawn upon by this area.
IoProperties - class org.writersforge.catalan.process.workers.io.IoProperties.
Specialized properties container for IoWorker.
IoProperties(IWorkProperties) - Constructor for class org.writersforge.catalan.process.workers.io.IoProperties
Creates a new instance of IoProperties.
IoWorker - class org.writersforge.catalan.process.workers.io.IoWorker.
IWorker implementation which provides support for reading and writing data from files and other stream-related sources.
IoWorker() - Constructor for class org.writersforge.catalan.process.workers.io.IoWorker
 
insertValue(int, StringBuffer, Object) - Method in class org.writersforge.catalan.text.AsciiFieldManager
Converts the newValue object into ASCII content and inserts it into the asciiData buffer.
isAtomic() - Method in class org.writersforge.catalan.layout.Constraint
Getter for property atomic, whether the area can be split or not.
isBreakable() - Method in class org.writersforge.catalan.layout.LayoutArea
Getter for property breakable, whether the area can be split or not.
isBreakable() - Method in class org.writersforge.catalan.layout.LayoutText
Getter for property breakable, whether the area can be split or not.
isBreakable() - Method in interface org.writersforge.catalan.layout.style.AreaStyle
Returns the breakable property of this area.
isBreakable() - Method in class org.writersforge.catalan.layout.style.DatumStyleWrapper
Returns the breakable property of this text.
isBreakable() - Method in class org.writersforge.catalan.layout.style.DefaultStyle
Returns the breakable property of this text.
isBreakable() - Method in class org.writersforge.catalan.layout.style.StyleChain
Returns the atomic property of this text.
isEqual() - Method in class org.writersforge.catalan.layout.Relation
Does the Relation allow distances exactly equal to the distance property?
isExclusive() - Method in class org.writersforge.catalan.process.workers.dispatch.MatchRunner
Returns true if this MatchRunner is an exclusive processor.
isFinished() - Method in class org.writersforge.catalan.process.workers.xml.DirectiveStack
Determines if the stack has reached the end of its run.
isFinished() - Method in class org.writersforge.catalan.transform.xml.DirectiveStack
Determines if the stack has reached the end of its run.
isGreaterThan() - Method in class org.writersforge.catalan.layout.Relation
Does the Relation allow distances greater than the distance property?
isHorizontal() - Method in class org.writersforge.catalan.templates.generic.GroupOp
Determines if this group op should be oriented horizontally.
isLeadingAttractorEdge() - Method in class org.writersforge.catalan.layout.Relation
Does the Relation refer to the leading edge of the attractor area?
isLeadingSatelliteEdge() - Method in class org.writersforge.catalan.layout.Relation
Does the Relation refer to the leading edge of the satellite area?
isLessThan() - Method in class org.writersforge.catalan.layout.Relation
Does the Relation allow distances less than the distance property?
isMatch(Object) - Method in class org.writersforge.catalan.process.workers.dispatch.MatchRunner
Determines if the given node should be processed by this MatchRunner.
isNullable() - Method in class org.writersforge.catalan.process.workers.sql.Field
Determines if this field can contain null values
isNullable() - Method in class org.writersforge.catalan.transform.text.SqlTable.Field
Determines if this field can contain null values
isProcessing() - Method in class org.writersforge.catalan.process.workers.BaseWorker
Determines if the IWorker is currently processing data in its process() method.
isReadOnly() - Method in class org.writersforge.catalan.process.queue.DefaultNamedQueue
Determines if a queue is read-only.
isReadOnly() - Method in class org.writersforge.catalan.process.queue.DefaultQueue
Determines if a queue is read-only.
isReadOnly() - Method in interface org.writersforge.catalan.process.queue.IQueue
Determines if a queue is read-only.
isReader() - Method in class org.writersforge.catalan.process.workers.io.IOAdapter
Determines if the wrapped object is suitable for reading from.
isReader() - Method in class org.writersforge.catalan.transform.io.IOAdapter
Determines if the wrapped object is suitable for reading from.
isRenderable() - Method in class org.writersforge.catalan.layout.LayoutArea
Determines if this area has renderable content.
isRenderable() - Method in class org.writersforge.catalan.layout.LayoutGroup
Determines if this area has renderable content.
isRenderable() - Method in class org.writersforge.catalan.layout.LayoutPadding
Determines if this area has renderable content.
isRenderable() - Method in class org.writersforge.catalan.layout.LayoutText
Determines if this area has renderable content.
isUnique() - Method in class org.writersforge.catalan.process.workers.sql.Field
Determines if this field must contain a unique value among all fields in the table.
isUnique() - Method in class org.writersforge.catalan.transform.text.SqlTable.Field
Determines if this field must contain a unique value among all fields in the table.
isVertical() - Method in class org.writersforge.catalan.layout.Relation
Is the Relation oriented along the horizontal axis?
isVertical() - Method in class org.writersforge.catalan.templates.generic.GroupOp
Determines if this group op should be oriented vertically.
isWriter() - Method in class org.writersforge.catalan.process.workers.io.IOAdapter
Determines if the wrapped object is suitable for writing to.
isWriter() - Method in class org.writersforge.catalan.transform.io.IOAdapter
Determines if the wrapped object is suitable for writing to.

J

JavaBeanProperties - class org.writersforge.catalan.process.workers.javabean.JavaBeanProperties.
Specialized properties container for JavaBeanWorker.
JavaBeanProperties(IWorkProperties) - Constructor for class org.writersforge.catalan.process.workers.javabean.JavaBeanProperties
Creates a new instance of TextProperties.
JavaBeanWorker - class org.writersforge.catalan.process.workers.javabean.JavaBeanWorker.
IWorker implementation which provides support for managing JavaBean objects.
JavaBeanWorker() - Constructor for class org.writersforge.catalan.process.workers.javabean.JavaBeanWorker
 
JavaToHtml - class org.writersforge.catalan.transform.xml.JavaToHtml.
Text processor for marking up Java source code with HTML formatting.
JavaToHtml() - Constructor for class org.writersforge.catalan.transform.xml.JavaToHtml
Creates a new instance of JavaToHtml.
JavaToHtmlCommand - class org.writersforge.catalan.process.workers.html.JavaToHtmlCommand.
Command for "xml-to-html".
JavaToHtmlCommand() - Constructor for class org.writersforge.catalan.process.workers.html.JavaToHtmlCommand
Creates a new instance of JavaToHtmlCommand.

L

LEADING_ATTRACTOR_EDGE_MASK - Static variable in class org.writersforge.catalan.layout.Relation
Relate to leading edge in attractor
LEADING_SATELLITE_EDGE_MASK - Static variable in class org.writersforge.catalan.layout.Relation
Relate to leading edge in satellite
LESS_THAN_EQUAL_MASK - Static variable in class org.writersforge.catalan.layout.Relation
Require less than or equal to distance
LESS_THAN_MASK - Static variable in class org.writersforge.catalan.layout.Relation
Require less than distance
LIGHT_WEIGHT - Static variable in class org.writersforge.catalan.layout.Relation
Optional Relation, use as a fallback, if nothing else needs the position
LOWER - Static variable in class org.writersforge.catalan.text.filters.CaseFilter
Case style for all lower case.
LayoutArea - class org.writersforge.catalan.layout.LayoutArea.
Lightweight component for expressing final renderable content.
LayoutArea(AreaStyle) - Constructor for class org.writersforge.catalan.layout.LayoutArea
Creates a new instance of LayoutArea.
LayoutContext - class org.writersforge.catalan.layout.LayoutContext.
Context for an ongoing iterative layout process.
LayoutContext(LayoutArea[]) - Constructor for class org.writersforge.catalan.layout.LayoutContext
Creates a new instance of LayoutContext
LayoutEngine - interface org.writersforge.catalan.layout.LayoutEngine.
Base interface for all layout engines.
LayoutFactory - class org.writersforge.catalan.layout.LayoutFactory.
Factory for creating LayoutEngine objects.
LayoutGroup - class org.writersforge.catalan.layout.LayoutGroup.
Grouping container for other LayoutArea objects.
LayoutGroup(AreaStyle) - Constructor for class org.writersforge.catalan.layout.LayoutGroup
Creates a new instance of LayoutGroup.
LayoutGroup(AreaStyle, int) - Constructor for class org.writersforge.catalan.layout.LayoutGroup
Creates a new instance of LayoutGroup with the given orientation.
LayoutPadding - class org.writersforge.catalan.layout.LayoutPadding.
A block of whitespace used to create flexible padding between other areas.
LayoutPadding(AreaStyle) - Constructor for class org.writersforge.catalan.layout.LayoutPadding
Creates a new instance of LayoutPadding with the given AreaStyle.
LayoutShape - class org.writersforge.catalan.layout.LayoutShape.
Non-textual drawing element.
LayoutShape(AreaStyle) - Constructor for class org.writersforge.catalan.layout.LayoutShape
Creates a new instance of LayoutShape.
LayoutText - class org.writersforge.catalan.layout.LayoutText.
A portion of renderable text.
LayoutText(AreaStyle) - Constructor for class org.writersforge.catalan.layout.LayoutText
Creates a new instance of LayoutText.
LayoutText(AreaStyle, String) - Constructor for class org.writersforge.catalan.layout.LayoutText
Creates a new instance of LayoutText.
LayoutText(AreaStyle, StyledText) - Constructor for class org.writersforge.catalan.layout.LayoutText
Creates a new instance of LayoutText.
LineSplitter - class org.writersforge.catalan.text.extractors.LineSplitter.
Text splitter which divides a text document into an array of lines.
LineSplitter(boolean) - Constructor for class org.writersforge.catalan.text.extractors.LineSplitter
Creates a new instance of LineSplitter.
LiteralOp - class org.writersforge.catalan.templates.generic.LiteralOp.
A template op wrapper for <literal> and static text.
LiteralOp(Datum, StyleMap) - Constructor for class org.writersforge.catalan.templates.generic.LiteralOp
Creates a new instance of LiteralOp.
LiteralOp(Datum, StyleMap, StyleChain) - Constructor for class org.writersforge.catalan.templates.generic.LiteralOp
Creates a new instance of LiteralOp with an optional StyleChain fallback.
LogWorker - class org.writersforge.catalan.process.workers.log.LogWorker.
IWorker implementation which provides support for logging messages.
LogWorker() - Constructor for class org.writersforge.catalan.process.workers.log.LogWorker
 
layoutArea(LayoutArea, LayoutContext, List) - Method in class org.writersforge.catalan.layout.SimpleFlowLayout
Lay out an area; unlike layoutRegion(), it can be called recursively.
layoutAreas(List) - Method in class org.writersforge.catalan.layout.AbstractLayoutEngine
Attempts to lay out all the areas in the supplied List.
layoutAreas(List) - Method in interface org.writersforge.catalan.layout.LayoutEngine
Attempts to lay out all the areas in the supplied List.
layoutPage(Page, LayoutArea[]) - Method in class org.writersforge.catalan.layout.AsciiLayout
Adds as many areas to the Page as will fit; returns the rest of them for the next Page.
layoutRegion(LayoutContext, Rectangle) - Method in class org.writersforge.catalan.layout.AsciiLayout
Attempts to lay out as many of the pending areas in the context as it can, into the provided region's bounding box.
layoutRegion(LayoutContext, Rectangle) - Method in interface org.writersforge.catalan.layout.LayoutEngine
Attempts to lay out as many of the pending areas in the context as it can, into the provided region's bounding box.
layoutRegion(LayoutContext, Rectangle) - Method in class org.writersforge.catalan.layout.SimpleFlowLayout
Attempts to lay out as many of the pending areas in the context as it can, into the provided region's bounding box.
listToDatumArray(List) - Static method in class org.writersforge.catalan.templates.RenderTemplate
Converts an ArrayList into an array of Datum objects.
listToLayoutAreaArray(List) - Static method in class org.writersforge.catalan.templates.RenderTemplate
Converts an ArrayList into an array of LayoutArea objects.
loadPropertyFile(String, Map) - Method in class org.writersforge.catalan.process.properties.XmlPropertyManager
Loads all properties from the given property file into the given Map.
loadTemplate(Reader) - Method in class org.writersforge.catalan.templates.GenericTemplate
Loads the XML layout template.
loadTemplate(ListDatum) - Method in class org.writersforge.catalan.templates.GenericTemplate
Loads the XML layout template.
loadXmlAttributes(Datum, Map) - Method in class org.writersforge.catalan.process.properties.XmlPropertyManager
Loads all XML attributes into the given Map.
loadXmlContents(Datum, List) - Method in class org.writersforge.catalan.process.properties.XmlPropertyManager
Loads all child nodes that match the given Bellows query path into the given Map.
loadXmlContents(Datum, String, Map) - Method in class org.writersforge.catalan.process.properties.XmlPropertyManager
Loads all XML attributes and all child nodes that match the given Bellows query path into the given Map.
loadXmlStack(Datum[]) - Static method in class org.writersforge.catalan.process.workers.xml.DirectiveStack
Factory method for creating a stack from an XML document.
loadXmlStack(Datum[]) - Static method in class org.writersforge.catalan.transform.xml.DirectiveStack
Factory method for creating a stack from an XML document.
logAllAlerts() - Method in class org.writersforge.catalan.process.queue.AlertQueue
Sends all Alerts to the logger.
logErrorAlerts() - Method in class org.writersforge.catalan.process.queue.AlertQueue
Sends all ERROR Alerts to the logger.
logFatalAlerts() - Method in class org.writersforge.catalan.process.queue.AlertQueue
Sends all FATAL Alerts to the logger.
logInfoAlerts() - Method in class org.writersforge.catalan.process.queue.AlertQueue
Sends all INFO Alerts to the logger.
logWarningAlerts() - Method in class org.writersforge.catalan.process.queue.AlertQueue
Sends all WARNING Alerts to the logger.
lookup(String) - Method in class org.writersforge.catalan.transform.ProcessorRegistry
Looks up a Transform XML element name in the registry and retrieves the corresponding NodeProcessor implementation.

M

MANDATORY_WEIGHT - Static variable in class org.writersforge.catalan.layout.Relation
The highest valid Relation, cannot be ignored
MEDIUM_WEIGHT - Static variable in class org.writersforge.catalan.layout.Relation
Moderately important Relation, should think twice before overriding
MINIMAL_WEIGHT - Static variable in class org.writersforge.catalan.layout.Relation
The lowest valid Relation weight, overridden by anything
MapProperties - class org.writersforge.catalan.process.properties.MapProperties.
IWorkProperties which wraps a Map object.
MapProperties(Map) - Constructor for class org.writersforge.catalan.process.properties.MapProperties
Creates a new instance of MapProperties.
Markup - class org.writersforge.catalan.layout.Markup.
Helper class to manage markup spans.
Markup() - Constructor for class org.writersforge.catalan.layout.Markup
Creates a new instance of Markup
Markup(FontStyle, int, int) - Constructor for class org.writersforge.catalan.layout.Markup
Creates a new instance of Markup with set values.
MatchBracesCommand - class org.writersforge.catalan.process.workers.text.MatchBracesCommand.
Implementation of "match-braces" command.
MatchBracesCommand() - Constructor for class org.writersforge.catalan.process.workers.text.MatchBracesCommand
Creates a new instance of MatchBracesCommand.
MatchRunner - class org.writersforge.catalan.process.workers.dispatch.MatchRunner.
Single match constraint for the dispatcher.
MatchRunner(IWorker[]) - Constructor for class org.writersforge.catalan.process.workers.dispatch.MatchRunner
Creates a new instance of MatchRunner that matches all nodes.
MatchRunner(String, IWorker[], boolean) - Constructor for class org.writersforge.catalan.process.workers.dispatch.MatchRunner
Creates a new instance of MatchRunner that compares text to a regular expression.
MatchRunner(Class, IWorker[], boolean) - Constructor for class org.writersforge.catalan.process.workers.dispatch.MatchRunner
Creates a new instance of MatchRunner that processes all nodes that implement a given class or interface.
MetadataException - exception org.writersforge.catalan.process.workers.MetadataException.
An exception for IWorkMetadata problems.
MetadataException(String) - Constructor for class org.writersforge.catalan.process.workers.MetadataException
Creates a new instance of MetadataException.
MetadataException(String, Throwable) - Constructor for class org.writersforge.catalan.process.workers.MetadataException
Creates a new instance of MetadataException.
MoveProcessor - class org.writersforge.catalan.transform.xform.MoveProcessor.
A Datum-only NodeProcessor for moving existing XML content to other parts of the same XML tree.
MoveProcessor(Datum) - Constructor for class org.writersforge.catalan.transform.xform.MoveProcessor
Creates a new instance of MoveProcessor from the XML spec.
MoveProcessor(String, String, String, int) - Constructor for class org.writersforge.catalan.transform.xform.MoveProcessor
Creates a new instance of MoveProcessor.
MultiLineCommentStripper - class org.writersforge.catalan.text.filters.MultiLineCommentStripper.
Text filter which removes multi-line comments from the input text document.
MultiLineCommentStripper(String, String) - Constructor for class org.writersforge.catalan.text.filters.MultiLineCommentStripper
Creates a new instance of MultiLineCommentStripper.
main(String[]) - Static method in class org.writersforge.catalan.GenericGenerator
Invokes the rendering process using the generic XML processing tools.
main(String[]) - Static method in class org.writersforge.catalan.process.CodeGenerator
Runs generic Catalan code generator.
main(String[]) - Static method in class org.writersforge.catalan.process.HibernateCodeGenerator
Runs Catalan Hibernate bindings code generator.
main(String[]) - Static method in class org.writersforge.catalan.process.WorkProcessor
Runs the given workers.
main(String[]) - Static method in class org.writersforge.catalan.transform.Transformer
Deprecated. Processes the Transform XML, loading data from one or more parameters.
main(String[]) - Static method in class org.writersforge.catalan.transform.io.DebugProcessor
Tests debugging output, since it's not so easy in a JUnit test.
mergeText(String[]) - Method in class org.writersforge.catalan.text.mergers.Concatenator
Collapses multiple text fragments into a single text document.
mergeText(String[]) - Method in interface org.writersforge.catalan.text.mergers.ITextMerger
Collapses multiple text fragments into a single text document.
moveNodes(String, String, int, NodeSelection) - Method in class org.writersforge.catalan.process.queue.QueueManager
Moves the selected nodes from the source queue to the destination queue.

N

NOT_EQUAL_MASK - Static variable in class org.writersforge.catalan.layout.Relation
Require not equal to distance
NOT_FOUND - Static variable in class org.writersforge.catalan.layout.style.DatumStyleWrapper
The standard tag for 'style value not found'
NOT_FOUND - Static variable in class org.writersforge.catalan.layout.style.DefaultStyle
Default value for an undefined integer property
NodeSelection - class org.writersforge.catalan.process.queue.NodeSelection.
Selection criteria for nodes within a IQueue.
NodeSelection() - Constructor for class org.writersforge.catalan.process.queue.NodeSelection
Creates a new instance of NodeSelection.
NormalizeCommand - class org.writersforge.catalan.process.workers.text.NormalizeCommand.
Implementation of "normalize" command.
NormalizeCommand() - Constructor for class org.writersforge.catalan.process.workers.text.NormalizeCommand
Creates a new instance of NormalizeCommand.
Normalizer - class org.writersforge.catalan.text.filters.Normalizer.
Text filter to perform whitespace (or custom) normalization.
Normalizer() - Constructor for class org.writersforge.catalan.text.filters.Normalizer
Creates a new instance of whitespace Normalizer.
Normalizer(String[], String, String[][]) - Constructor for class org.writersforge.catalan.text.filters.Normalizer
Creates a new instance of Normalizer with custom normalization.
Normalizer - class org.writersforge.catalan.transform.text.Normalizer.
A text processor which cleans up the input text content according to its set of configurable rules.
Normalizer(Datum) - Constructor for class org.writersforge.catalan.transform.text.Normalizer
Creates a new instance of Normalizer from the XML spec.
Normalizer() - Constructor for class org.writersforge.catalan.transform.text.Normalizer
Creates a new instance of Normalizer.
newLayoutEngine(String) - Static method in class org.writersforge.catalan.layout.LayoutFactory
Creates a new layout engine, based on the input parameters.
nextArea() - Method in class org.writersforge.catalan.layout.LayoutContext
Pulls the next area off the stack.
normalize(StringBuffer) - Method in class org.writersforge.catalan.text.AsciiFieldManager
Fills in current padding without touching any existing data fields.

O

ObjectToDatum - class org.writersforge.catalan.transform.xml.ObjectToDatum.
A data processor which converts a List of java objects into Datum content.
ObjectToDatum(Datum) - Constructor for class org.writersforge.catalan.transform.xml.ObjectToDatum
Creates a new instance of ObjectToDatum from the XML spec.
ObjectToDatum(DirectiveStack) - Constructor for class org.writersforge.catalan.transform.xml.ObjectToDatum
Creates a new instance of ObjectToDatum.
OptionalPropertyInfo - class org.writersforge.catalan.process.workers.OptionalPropertyInfo.
PropertyInfo with an additional default field.
OptionalPropertyInfo(String, String, Object) - Constructor for class org.writersforge.catalan.process.workers.OptionalPropertyInfo
Creates a new instance of OptionalPropertyInfo.
OptionalPropertyInfo(String, String, Object, Class[]) - Constructor for class org.writersforge.catalan.process.workers.OptionalPropertyInfo
Creates a new instance of OptionalPropertyInfo.
org.writersforge.catalan - package org.writersforge.catalan
Catalan Document Creation Framework.
org.writersforge.catalan.layout - package org.writersforge.catalan.layout
Catalan Layout API.
org.writersforge.catalan.layout.style - package org.writersforge.catalan.layout.style
Catalan Style API.
org.writersforge.catalan.process - package org.writersforge.catalan.process
Catalan Processing API.
org.writersforge.catalan.process.commands - package org.writersforge.catalan.process.commands
Catalan Worker Command API.
org.writersforge.catalan.process.properties - package org.writersforge.catalan.process.properties
Catalan Worker Properties.
org.writersforge.catalan.process.queue - package org.writersforge.catalan.process.queue
Catalan Processing Queues.
org.writersforge.catalan.process.workers - package org.writersforge.catalan.process.workers
Catalan Base Worker API.
org.writersforge.catalan.process.workers.control - package org.writersforge.catalan.process.workers.control
Catalan Control Workers.
org.writersforge.catalan.process.workers.dispatch - package org.writersforge.catalan.process.workers.dispatch
 
org.writersforge.catalan.process.workers.html - package org.writersforge.catalan.process.workers.html
Catalan HTML Workers.
org.writersforge.catalan.process.workers.io - package org.writersforge.catalan.process.workers.io
Catalan I/O Workers.
org.writersforge.catalan.process.workers.javabean - package org.writersforge.catalan.process.workers.javabean
Catalan JavaBean Workers.
org.writersforge.catalan.process.workers.log - package org.writersforge.catalan.process.workers.log
Catalan Logging Workers.
org.writersforge.catalan.process.workers.partition - package org.writersforge.catalan.process.workers.partition
 
org.writersforge.catalan.process.workers.pdf - package org.writersforge.catalan.process.workers.pdf
Catalan PDF Workers.
org.writersforge.catalan.process.workers.queue - package org.writersforge.catalan.process.workers.queue
Catalan Queue Workers.
org.writersforge.catalan.process.workers.sql - package org.writersforge.catalan.process.workers.sql
Catalan SQL Workers.
org.writersforge.catalan.process.workers.text - package org.writersforge.catalan.process.workers.text
Catalan Text Workers.
org.writersforge.catalan.process.workers.velocity - package org.writersforge.catalan.process.workers.velocity
Catalan Velocity Workers.
org.writersforge.catalan.process.workers.xml - package org.writersforge.catalan.process.workers.xml
Catalan XML Workers.
org.writersforge.catalan.process.workspace - package org.writersforge.catalan.process.workspace
Catalan Workspace API.
org.writersforge.catalan.renderers - package org.writersforge.catalan.renderers
Catalan Renderer Engines.
org.writersforge.catalan.templates - package org.writersforge.catalan.templates
Catalan Template API.
org.writersforge.catalan.templates.generic - package org.writersforge.catalan.templates.generic
Catalan Generic Template Helper Classes.
org.writersforge.catalan.text - package org.writersforge.catalan.text
 
org.writersforge.catalan.text.extractors - package org.writersforge.catalan.text.extractors
 
org.writersforge.catalan.text.filters - package org.writersforge.catalan.text.filters
 
org.writersforge.catalan.text.fragfilters - package org.writersforge.catalan.text.fragfilters
 
org.writersforge.catalan.text.mergers - package org.writersforge.catalan.text.mergers
 
org.writersforge.catalan.transform - package org.writersforge.catalan.transform
Catalan Data Transformation Package [Deprecated].
org.writersforge.catalan.transform.external - package org.writersforge.catalan.transform.external
Catalan External Data Transformation Package [Deprecated].
org.writersforge.catalan.transform.io - package org.writersforge.catalan.transform.io
Catalan I/O Data Transformation Package [Deprecated].
org.writersforge.catalan.transform.text - package org.writersforge.catalan.transform.text
Catalan Text Data Transformation Package [Deprecated].
org.writersforge.catalan.transform.xform - package org.writersforge.catalan.transform.xform
Catalan XML-to-XML Data Transformation Package [Deprecated].
org.writersforge.catalan.transform.xml - package org.writersforge.catalan.transform.xml
Catalan XML Data Transformation Package [Deprecated].
org.writersforge.catalan.util - package org.writersforge.catalan.util
Catalan Utility API.

P

PaddingOp - class org.writersforge.catalan.templates.generic.PaddingOp.
 
PaddingOp(Datum, StyleMap) - Constructor for class org.writersforge.catalan.templates.generic.PaddingOp
Creates a new instance of PaddingOp.
PaddingOp(Datum, StyleMap, StyleChain) - Constructor for class org.writersforge.catalan.templates.generic.PaddingOp
Creates a new instance of PaddingOp with an optional StyleChain fallback.
Page - class org.writersforge.catalan.layout.Page.
A single page of final output.
Page(Book, int, int) - Constructor for class org.writersforge.catalan.layout.Page
Creates a new instance of Page.
ParagraphSplitter - class org.writersforge.catalan.text.extractors.ParagraphSplitter.
Text splitter which divides text content into paragraphs delimited by one or more blank (whitespace-only) lines.
ParagraphSplitter() - Constructor for class org.writersforge.catalan.text.extractors.ParagraphSplitter
 
Partition - class org.writersforge.catalan.process.workers.partition.Partition.
Parsing definition for this partition.
Partition(String, String, String) - Constructor for class org.writersforge.catalan.process.workers.partition.Partition
Creates a new instance of Partition which matches a fragment of text bounded by the start and end patterns.
Partition(String, String, String, Datum[]) - Constructor for class org.writersforge.catalan.process.workers.partition.Partition
Creates a new instance of Partition which matches a fragment of text bounded by the start and end patterns.
PartitionIndexer - class org.writersforge.catalan.process.workers.partition.PartitionIndexer.
Scans a text document and divides it into partitions, according to the supplied Partition objects.
PartitionIndexer(Partition[]) - Constructor for class org.writersforge.catalan.process.workers.partition.PartitionIndexer
Creates a new instance of PartitionIndexer.
PartitionProperties - class org.writersforge.catalan.process.workers.partition.PartitionProperties.
Specialized properties container for ParserWorker.
PartitionProperties(IWorkProperties) - Constructor for class org.writersforge.catalan.process.workers.partition.PartitionProperties
Creates a new instance of PartitionProperties.
PartitionRange - class org.writersforge.catalan.process.workers.partition.PartitionRange.
Index and partition type info for a single partition.
PartitionRange(String, int, int) - Constructor for class org.writersforge.catalan.process.workers.partition.PartitionRange
Creates a new instance of PartitionRange.
PartitionSplitCommand - class org.writersforge.catalan.process.workers.partition.PartitionSplitCommand.
Implementation of command "split", to chop text documents into one node per partition.
PartitionSplitCommand() - Constructor for class org.writersforge.catalan.process.workers.partition.PartitionSplitCommand
Creates a new instance of PartitionSplitCommand.
PartitionWorker - class org.writersforge.catalan.process.workers.partition.PartitionWorker.
Worker to split text documents into partitions and perform operations on each partition.
PartitionWorker() - Constructor for class org.writersforge.catalan.process.workers.partition.PartitionWorker
 
PdfRenderer - class org.writersforge.catalan.renderers.PdfRenderer.
Generates a PDF file from one or more Page objects created by a RenderTemplate class.
PdfRenderer() - Constructor for class org.writersforge.catalan.renderers.PdfRenderer
Creates a new instance of PdfRenderer
PdfWorker - class org.writersforge.catalan.process.workers.pdf.PdfWorker.
IWorker implementation which provides support for creating an reading PDF documents.
PdfWorker() - Constructor for class org.writersforge.catalan.process.workers.pdf.PdfWorker
 
PdfgenProcessor - class org.writersforge.catalan.transform.external.PdfgenProcessor.
Node processor for creating PDF files with GenericTemplate engine.
PdfgenProcessor(Datum) - Constructor for class org.writersforge.catalan.transform.external.PdfgenProcessor
Creates a new instance of PdfgenProcessor from the XML spec.
PdfgenProcessor(ListDatum) - Constructor for class org.writersforge.catalan.transform.external.PdfgenProcessor
Creates a new instance of PdfgenProcessor.
ProcessException - exception org.writersforge.catalan.process.ProcessException.
A base exception for Catalan processing problems.
ProcessException(String) - Constructor for class org.writersforge.catalan.process.ProcessException
Creates a new instance of ProcessException.
ProcessException(String, Throwable) - Constructor for class org.writersforge.catalan.process.ProcessException
Creates a new instance of ProcessException.
ProcessorRegistry - class org.writersforge.catalan.transform.ProcessorRegistry.
Central registry for connecting XML transform elements up to NodeProcessor implementations.
ProcessorRegistry() - Constructor for class org.writersforge.catalan.transform.ProcessorRegistry
Creates a new instance of ProcessorRegistry with the default Transform XML mapping.
ProcessorRegistry(Datum) - Constructor for class org.writersforge.catalan.transform.ProcessorRegistry
Creates a new instance of ProcessorRegistry.
PropertyInfo - class org.writersforge.catalan.process.workers.PropertyInfo.
Metadata for a command property.
PropertyInfo(String, String) - Constructor for class org.writersforge.catalan.process.workers.PropertyInfo
Creates a new instance of PropertyInfo.
PropertyInfo(String, String, Class[]) - Constructor for class org.writersforge.catalan.process.workers.PropertyInfo
Creates a new instance of PropertyInfo with a type restriction.
parseArgs(String[]) - Method in class org.writersforge.catalan.GenericGenerator
Parses and processes the command-line arguments.
process(IWorkProperties, IWorkspace) - Method in class org.writersforge.catalan.process.workers.BaseJob
Perform one stage of processing in the workspace.
process(IWorkProperties, IWorkspace) - Method in class org.writersforge.catalan.process.workers.BaseWorker
Perform one stage of processing in the workspace.
process(IWorkProperties, IWorkspace) - Method in interface org.writersforge.catalan.process.workers.IWorker
Perform one stage of processing in the workspace.
process(Book) - Method in class org.writersforge.catalan.templates.RenderTemplate
Processes all content in the Book's ListDatum container according to the rules in this template, and divides the results into separate Pages.
process(String[], List) - Method in class org.writersforge.catalan.transform.Transformer
Deprecated. Runs the List of input nodes through a set of processors, by id.
processAll(List) - Method in class org.writersforge.catalan.transform.Transformer
Deprecated. Runs the List of input nodes through every processor in the Transformer's XML specification, in order.
processBatch(String[], IWorkProperties) - Method in class org.writersforge.catalan.process.WorkProcessor
Executes the workers in workerNames, in the order they occur in the array, passing the given runtime properties into each invocation.
processFromArgs() - Method in class org.writersforge.catalan.process.WorkProcessor
Executes the workers named on the command line, using the command line arguments as the runtime properties.
processNode(Object, IWorkProperties, IWorkspace) - Method in class org.writersforge.catalan.process.workers.dispatch.MatchRunner
Runs the data node through all workers associated with this MatchRunner.
processNode(Object) - Method in class org.writersforge.catalan.transform.GroupProcessor
Process a single node.
processNode(Object) - Method in class org.writersforge.catalan.transform.external.PdfgenProcessor
Process a single node.
processNode(Object) - Method in class org.writersforge.catalan.transform.external.VelocityProcessor
Process a single node.
processNode(Object) - Method in class org.writersforge.catalan.transform.io.DebugProcessor
Process a single node.
processNode(Object) - Method in class org.writersforge.catalan.transform.io.ExportJavaProcessor
Process a single node.
processNode(Object) - Method in class org.writersforge.catalan.transform.io.ExportProcessor
Process a single node.
processNode(Object) - Method in class org.writersforge.catalan.transform.io.ImportProcessor
Process a single node.
processNode(Object) - Method in class org.writersforge.catalan.transform.text.Concatenator
Process a single node.
processNode(Object) - Method in class org.writersforge.catalan.transform.text.FromAsciiConverter
Process a single node.
processNode(Object) - Method in class org.writersforge.catalan.transform.text.SqlProcessor
Process a single node.
processNode(Object) - Method in class org.writersforge.catalan.transform.text.TextProcessor
Process a single node.
processNode(Object) - Method in class org.writersforge.catalan.transform.text.ToAsciiConverter
Process a single node.
processNode(Object) - Method in class org.writersforge.catalan.transform.xform.XFormProcessor
Process a single node.
processNode(Object) - Method in class org.writersforge.catalan.transform.xml.BeanToXml
Process a single node.
processNode(Object) - Method in class org.writersforge.catalan.transform.xml.DatumToObject
Process a single node.
processNode(Object) - Method in class org.writersforge.catalan.transform.xml.ObjectToDatum
Process a single node.
processNode(Object) - Method in class org.writersforge.catalan.transform.xml.TextToLattice
Process a single node.
processNode(Object) - Method in class org.writersforge.catalan.transform.xml.XmlSelectProcessor
Process a single node.
processNode(Object) - Method in class org.writersforge.catalan.transform.xml.XmlToBean
Process a single node.
processNode(Object) - Method in class org.writersforge.catalan.transform.xml.XmlToHtml
Process a single node.
processTemplate(String, Map) - Method in class org.writersforge.catalan.process.workers.velocity.VelocityRunner
Processes the given Velocity template against the supplied input nodes.
processTemplate(String, List) - Method in class org.writersforge.catalan.transform.external.VelocityRunner
Processes the given Velocity template against the supplied input nodes.
processText(String) - Method in class org.writersforge.catalan.transform.text.Normalizer
Processes the text node.
processText(String) - Method in class org.writersforge.catalan.transform.text.TextProcessor
Processes the text node.
processText(String) - Method in class org.writersforge.catalan.transform.text.TextReplacer
Processes the text node.
processText(String) - Method in class org.writersforge.catalan.transform.text.TokenSplitter
Processes the text node.
processText(String) - Method in class org.writersforge.catalan.transform.text.VariableTextReplacer
Processes the text node.
processText(String) - Method in class org.writersforge.catalan.transform.xml.JavaToHtml
Processes the text node.
processWorker(String, IWorkProperties) - Method in class org.writersforge.catalan.process.WorkProcessor
Executes the single worker or job of the given name, using the given runtime properties.
processXmlNode(Datum, List, XmlCommonProperties) - Method in class org.writersforge.catalan.process.workers.xml.BaseQueryCommand
Runs command on a single node of XML content.
processXmlNode(Datum, List, XmlCommonProperties) - Method in class org.writersforge.catalan.process.workers.xml.XmlCopyCommand
Runs command on a single node of XML content.
processXmlNode(Datum, List, XmlCommonProperties) - Method in class org.writersforge.catalan.process.workers.xml.XmlExploderCommand
Runs command on a single node of XML content.
processXmlNode(Datum, List, XmlCommonProperties) - Method in class org.writersforge.catalan.process.workers.xml.XmlInlineCommand
Runs command on a single node of XML content.
processXmlNode(Datum, List, XmlCommonProperties) - Method in class org.writersforge.catalan.process.workers.xml.XmlInsertCommand
Runs command on a single node of XML content.
processXmlNode(Datum, List, XmlCommonProperties) - Method in class org.writersforge.catalan.process.workers.xml.XmlRenameCommand
Runs command on a single node of XML content.
processXmlNode(Datum, List, XmlCommonProperties) - Method in class org.writersforge.catalan.process.workers.xml.XmlStyleCommand
Runs command on a single node of XML content.
processXmlNode(Datum, List, XmlCommonProperties) - Method in class org.writersforge.catalan.process.workers.xml.XmlTagCommand
Runs command on a single node of XML content.
processXmlNode(Datum, List, XmlCommonProperties) - Method in class org.writersforge.catalan.process.workers.xml.XmlToAttributeCommand
Runs command on a single node of XML content.
processXmlNode(Datum, List, XmlCommonProperties) - Method in class org.writersforge.catalan.process.workers.xml.XmlToElementCommand
Runs command on a single node of XML content.
processXmlNode(Datum, List, XmlCommonProperties) - Method in class org.writersforge.catalan.process.workers.xml.XmlWrapCommand
Runs command on a single node of XML content.

Q

QueueException - exception org.writersforge.catalan.process.queue.QueueException.
An exception for IQueue-related problems.
QueueException(String) - Constructor for class org.writersforge.catalan.process.queue.QueueException
Creates a new instance of QueueException.
QueueException(String, Throwable) - Constructor for class org.writersforge.catalan.process.queue.QueueException
Creates a new instance of QueueException.
QueueManager - class org.writersforge.catalan.process.queue.QueueManager.
Manager for a group of named IQueue objects.
QueueManager() - Constructor for class org.writersforge.catalan.process.queue.QueueManager
Creates a new instance of QueueManager with no existing queues.
QueueManager(Map) - Constructor for class org.writersforge.catalan.process.queue.QueueManager
Creates a new instance of QueueManager with the given queues.
QueueNodeWorker - class org.writersforge.catalan.process.workers.queue.QueueNodeWorker.
IWorker implementation which provides queue maintenance functions.
QueueNodeWorker() - Constructor for class org.writersforge.catalan.process.workers.queue.QueueNodeWorker
 
QueueProperties - class org.writersforge.catalan.process.workers.queue.QueueProperties.
Specialized properties container for QueueWorker and QueueNodeWorker.
QueueProperties(IWorkProperties) - Constructor for class org.writersforge.catalan.process.workers.queue.QueueProperties
Creates a new instance of QueueProperties.
QueueSortWorker - class org.writersforge.catalan.process.workers.queue.QueueSortWorker.
IWorker implementation which provides queue sorting functions.
QueueSortWorker() - Constructor for class org.writersforge.catalan.process.workers.queue.QueueSortWorker
 
QueueWorker - class org.writersforge.catalan.process.workers.queue.QueueWorker.
IWorker implementation which provides queue maintenance functions.
QueueWorker() - Constructor for class org.writersforge.catalan.process.workers.queue.QueueWorker
 
query(String) - Method in class org.writersforge.catalan.process.workers.velocity.DatumAdapter
Runs the Bellows query and wraps all results in other DatumAdapter objects.
query(String) - Method in class org.writersforge.catalan.transform.external.DatumAdapter
Runs the Bellows query and wraps all results in other DatumAdapter objects.
queryPcdata(String) - Method in class org.writersforge.catalan.process.workers.velocity.DatumAdapter
Runs the Bellows query, then extracts the PCDATA content from each result node.
queryPcdata(String) - Method in class org.writersforge.catalan.transform.external.DatumAdapter
Runs the Bellows query, then extracts the PCDATA content from each result node.
queryProperties(String, String) - Method in class org.writersforge.catalan.process.workers.velocity.DatumAdapter
Runs the Bellows query then extracts the Datum property described in attribute from each query result.
queryProperties(String, String) - Method in class org.writersforge.catalan.transform.external.DatumAdapter
Runs the Bellows query then extracts the Datum property described in attribute from each query result.

R

RegexpExtractor - class org.writersforge.catalan.text.extractors.RegexpExtractor.
Text extractor which extracts text from all parenthetical groups defined in the driving regular expression.
RegexpExtractor(String, boolean) - Constructor for class org.writersforge.catalan.text.extractors.RegexpExtractor
Creates a new instance of RegexpExtractor.
RegexpFilterCommand - class org.writersforge.catalan.process.workers.text.RegexpFilterCommand.
Implementation of "regexp-filter" command.
RegexpFilterCommand() - Constructor for class org.writersforge.catalan.process.workers.text.RegexpFilterCommand
Creates a new instance of RegexpFilterCommand.
RegexpLineSplitter - class org.writersforge.catalan.text.extractors.RegexpLineSplitter.
Text splitter which splits text each time a single line matches the given regular expression.
RegexpLineSplitter(String, boolean) - Constructor for class org.writersforge.catalan.text.extractors.RegexpLineSplitter
Creates a new instance of RegexpLineSplitter.
RegexpSplitter - class org.writersforge.catalan.text.extractors.RegexpSplitter.
Text splitter which identifies delimiters according to a regular expression.
RegexpSplitter(String, boolean) - Constructor for class org.writersforge.catalan.text.extractors.RegexpSplitter
Creates a new instance of MultilineSplitter.
RegionMap - interface org.writersforge.catalan.templates.RegionMap.
Base interface for defining flow regions in a Section.
RegistryException - exception org.writersforge.catalan.process.workers.RegistryException.
An exception for WorkerRegistry problems.
RegistryException(String) - Constructor for class org.writersforge.catalan.process.workers.RegistryException
Creates a new instance of RegistryException.
RegistryException(String, Throwable) - Constructor for class org.writersforge.catalan.process.workers.RegistryException
Creates a new instance of RegistryException.
Relation - class org.writersforge.catalan.layout.Relation.
A constraints-based relationship between two LayoutArea objects.
Relation(LayoutArea, int, int) - Constructor for class org.writersforge.catalan.layout.Relation
Creates a new instance of Relation.
Relation(LayoutArea, int, int, int) - Constructor for class org.writersforge.catalan.layout.Relation
Creates a new instance of Relation
Relation.Above - class org.writersforge.catalan.layout.Relation.Above.
Convenience class to constrain an area that must remain vertically above the previous area in the layout.
Relation.Above(LayoutArea, int, int) - Constructor for class org.writersforge.catalan.layout.Relation.Above
Creates a new instance of Above, essentially a convenience wrapper around the base Relation class with simpler parameters and distinct type (for easier checking with instanceof).
Relation.Above(LayoutArea, int, int, int) - Constructor for class org.writersforge.catalan.layout.Relation.Above
Creates a new instance of Above, essentially a convenience wrapper around the base Relation class with simpler parameters and distinct type (for easier checking with instanceof).
Relation.Below - class org.writersforge.catalan.layout.Relation.Below.
Convenience class to constrain an area that must remain vertically below the previous area in the layout.
Relation.Below(LayoutArea, int, int) - Constructor for class org.writersforge.catalan.layout.Relation.Below
Creates a new instance of Below, essentially a convenience wrapper around the base Relation class with simpler parameters and distinct type (for easier checking with instanceof).
Relation.Below(LayoutArea, int, int, int) - Constructor for class org.writersforge.catalan.layout.Relation.Below
Creates a new instance of Below, essentially a convenience wrapper around the base Relation class with simpler parameters and distinct type (for easier checking with instanceof).
Relation.Indent - class org.writersforge.catalan.layout.Relation.Indent.
Convenience class to constrain an area that must remain indented to the right of the previous area in the layout (leftward indentation can be achieved with a negative distance).
Relation.Indent(LayoutArea, int, int) - Constructor for class org.writersforge.catalan.layout.Relation.Indent
Creates a new instance of Above, essentially a convenience wrapper around the base Relation class with simpler parameters and distinct type (for easier checking with instanceof).
RenameProcessor - class org.writersforge.catalan.transform.xform.RenameProcessor.
A Datum-only NodeProcessor for renaming XML content.
RenameProcessor(Datum) - Constructor for class org.writersforge.catalan.transform.xform.RenameProcessor
Creates a new instance of RenameProcessor from the XML spec.
RenameProcessor(String, String, String) - Constructor for class org.writersforge.catalan.transform.xform.RenameProcessor
Creates a new instance of RenameProcessor.
RenderTemplate - class org.writersforge.catalan.templates.RenderTemplate.
Base class for all rendering templates.
RenderTemplate() - Constructor for class org.writersforge.catalan.templates.RenderTemplate
Creates a new instance of RenderTemplate using the default LayoutEngine.
RenderTemplate(String) - Constructor for class org.writersforge.catalan.templates.RenderTemplate
Creates a new instance of RenderTemplate using the requested LayoutEngine.
RenderTemplate(LayoutEngine) - Constructor for class org.writersforge.catalan.templates.RenderTemplate
Creates a new instance of RenderTemplate using the given LayoutEngine.
Renderer - class org.writersforge.catalan.renderers.Renderer.
Abstract base class for rendering Page objects into a final output format.
Renderer() - Constructor for class org.writersforge.catalan.renderers.Renderer
 
ReplaceCommand - class org.writersforge.catalan.process.workers.text.ReplaceCommand.
Implementation of "replace" command.
ReplaceCommand() - Constructor for class org.writersforge.catalan.process.workers.text.ReplaceCommand
Creates a new instance of ReplaceCommand.
ResolveCommand - class org.writersforge.catalan.process.workers.text.ResolveCommand.
Implementation of "resolve" command.
ResolveCommand() - Constructor for class org.writersforge.catalan.process.workers.text.ResolveCommand
Creates a new instance of ResolveCommand.
rejectArea(LayoutArea) - Method in class org.writersforge.catalan.layout.LayoutContext
Puts the area into the reject pile, to be deferred to the next page.
removeAlert(Alert) - Method in class org.writersforge.catalan.process.queue.AlertQueue
Removes the alert from the queue.
removeProperty(String) - Method in class org.writersforge.catalan.layout.Book
Delete all traces of the named property
renameQueue(String, String) - Method in class org.writersforge.catalan.process.queue.QueueManager
Renames the queue to the given name.
render(Book) - Method in class org.writersforge.catalan.renderers.Renderer
Renders an entire Book, pulling all data from the Book's Page array.
renderArea(LayoutArea) - Method in class org.writersforge.catalan.renderers.Renderer
Renders a single LayoutArea object within the current Page.
renderArea(LayoutArea) - Method in class org.writersforge.catalan.renderers.TextRenderer
Renders a single LayoutArea within the current Page.
renderPage(Book, int) - Method in class org.writersforge.catalan.renderers.Renderer
Renders a single page of a book.
renderSection(Section, Book) - Method in class org.writersforge.catalan.templates.RenderTemplate
Converts a section of the document into Page objects, using the data in the Book as an input source.
renderShapeArea(LayoutShape) - Method in class org.writersforge.catalan.renderers.PdfRenderer
Renders a single LayoutShape within the current Page.
renderShapeArea(LayoutShape) - Method in class org.writersforge.catalan.renderers.Renderer
Renders a single LayoutShape area within the current Page.
renderShapeArea(LayoutShape) - Method in class org.writersforge.catalan.renderers.TextRenderer
Renders a single LayoutShape within the current Page.
renderTextArea(LayoutText) - Method in class org.writersforge.catalan.renderers.PdfRenderer
Renders a single LayoutText within the current Page.
renderTextArea(LayoutText) - Method in class org.writersforge.catalan.renderers.Renderer
Renders a single LayoutText area within the current Page.
renderTextArea(LayoutText) - Method in class org.writersforge.catalan.renderers.TextRenderer
Renders a single LayoutText within the current Page.
reset() - Method in class org.writersforge.catalan.process.workers.xml.DirectiveStack
Initializes the stack to its initial state.
reset() - Method in class org.writersforge.catalan.transform.xml.DirectiveStack
Initializes the stack to its initial state.
resolve(Datum) - Method in class org.writersforge.catalan.templates.generic.ForEachOp
Runs a Datum XML node through the op and returns a List of LayoutArea objects.
resolve(Datum) - Method in class org.writersforge.catalan.templates.generic.GenericOp
Runs a Datum XML node through the op and returns a List of LayoutArea objects.
resolve(Datum) - Method in class org.writersforge.catalan.templates.generic.GroupOp
Runs a Datum XML node through the op and returns a List of LayoutArea objects.
resolve(Datum) - Method in class org.writersforge.catalan.templates.generic.IfOp
Runs a Datum XML node through the op and returns a List of LayoutArea objects.
resolve(Datum) - Method in class org.writersforge.catalan.templates.generic.ImageOp
Runs a Datum XML node through the op and returns a List of LayoutArea objects.
resolve(Datum) - Method in class org.writersforge.catalan.templates.generic.LiteralOp
Runs a Datum XML node through the op and returns a List of LayoutArea objects.
resolve(Datum) - Method in class org.writersforge.catalan.templates.generic.PaddingOp
Runs a Datum XML node through the op and returns a List of LayoutArea objects.
resolve(Datum) - Method in class org.writersforge.catalan.templates.generic.TableOp
Runs a Datum XML node through the op and returns a List of LayoutArea objects.
resolve(Datum) - Method in class org.writersforge.catalan.templates.generic.TextOp
Runs a Datum XML node through the op and returns a List of LayoutArea objects.
resolveParameter(char, Datum) - Method in class org.writersforge.catalan.templates.generic.GenericOp
Attempts to resolve a parameter against a Datum.
resolvePath(String, Datum) - Method in class org.writersforge.catalan.templates.generic.GenericOp
Attempts to resolve a parameterized query path.
run() - Method in class org.writersforge.catalan.GenericGenerator
Fires off the document generator, given the current input and output file settings and output format.
run() - Method in class org.writersforge.catalan.process.CodeGenerator
Runs the code generator.
run() - Method in class org.writersforge.catalan.process.HibernateCodeGenerator
Runs the code generator.
run(CommandContext) - Method in interface org.writersforge.catalan.process.commands.ICommand
Invokes this command against the given workspace with the given runtime properties.
run(CommandContext) - Method in class org.writersforge.catalan.process.workers.html.JavaToHtmlCommand
Invokes this command against the given workspace with the given runtime properties.
run(CommandContext) - Method in class org.writersforge.catalan.process.workers.html.XmlToHtmlCommand
Invokes this command against the given workspace with the given runtime properties.
run(CommandContext) - Method in class org.writersforge.catalan.process.workers.io.ExportCommand
Invokes this command against the given workspace with the given runtime properties.
run(CommandContext) - Method in class org.writersforge.catalan.process.workers.io.ExportJavaCommand
Invokes this command against the given workspace with the given runtime properties.
run(CommandContext) - Method in class org.writersforge.catalan.process.workers.io.ImportCommand
Invokes this command against the given workspace with the given runtime properties.
run(CommandContext) - Method in class org.writersforge.catalan.process.workers.javabean.BeanToXmlCommand
Invokes this command against the given workspace with the given runtime properties.
run(CommandContext) - Method in class org.writersforge.catalan.process.workers.javabean.XmlToBeanCommand
Invokes this command against the given workspace with the given runtime properties.
run(CommandContext) - Method in class org.writersforge.catalan.process.workers.partition.PartitionSplitCommand
Invokes this command against the given workspace with the given runtime properties.
run(CommandContext) - Method in class org.writersforge.catalan.process.workers.text.ChangeCaseCommand
Invokes this command against the given workspace with the given runtime properties.
run(CommandContext) - Method in class org.writersforge.catalan.process.workers.text.ConcatenateCommand
Invokes this command against the given workspace with the given runtime properties.
run(CommandContext) - Method in class org.writersforge.catalan.process.workers.text.ExtractCommand
Invokes this command against the given workspace with the given runtime properties.
run(CommandContext) - Method in class org.writersforge.catalan.process.workers.text.FromAsciiCommand
Invokes this command against the given workspace with the given runtime properties.
run(CommandContext) - Method in class org.writersforge.catalan.process.workers.text.MatchBracesCommand
Invokes this command against the given workspace with the given runtime properties.
run(CommandContext) - Method in class org.writersforge.catalan.process.workers.text.NormalizeCommand
Invokes this command against the given workspace with the given runtime properties.
run(CommandContext) - Method in class org.writersforge.catalan.process.workers.text.RegexpFilterCommand
Invokes this command against the given workspace with the given runtime properties.
run(CommandContext) - Method in class org.writersforge.catalan.process.workers.text.ReplaceCommand
Invokes this command against the given workspace with the given runtime properties.
run(CommandContext) - Method in class org.writersforge.catalan.process.workers.text.ResolveCommand
Invokes this command against the given workspace with the given runtime properties.
run(CommandContext) - Method in class org.writersforge.catalan.process.workers.text.SplitCommand
Invokes this command against the given workspace with the given runtime properties.
run(CommandContext) - Method in class org.writersforge.catalan.process.workers.text.StripCommentsCommand
Invokes this command against the given workspace with the given runtime properties.
run(CommandContext) - Method in class org.writersforge.catalan.process.workers.text.TextToXmlCommand
Invokes this command against the given workspace with the given runtime properties.
run(CommandContext) - Method in class org.writersforge.catalan.process.workers.text.ToAsciiCommand
Invokes this command against the given workspace with the given runtime properties.
run(CommandContext) - Method in class org.writersforge.catalan.process.workers.text.TokenizeCommand
Invokes this command against the given workspace with the given runtime properties.
run(CommandContext) - Method in class org.writersforge.catalan.process.workers.xml.BaseQueryCommand
Invokes this command against the given workspace with the given runtime properties.
runQuery(String, Datum) - Method in class org.writersforge.catalan.templates.generic.GenericOp
Performs a query on the supplied Datum tree, resolving parameterized variables and managing absolute and relative paths.

S

SENTENCE - Static variable in class org.writersforge.catalan.text.filters.CaseFilter
Case style for capitalizing the first letter of every sentence.
SIMPLE_FLOW_ENGINE - Static variable in class org.writersforge.catalan.layout.LayoutFactory
The factory name for the SimpleFlowLayout engine.
STYLE_ENUM - Static variable in interface org.writersforge.catalan.layout.style.FontStyle
Enumeration of font styles; uses constants from Style
Section - class org.writersforge.catalan.templates.Section.
A single section of a larger document.
Section(RegionMap, Datum[], Datum[]) - Constructor for class org.writersforge.catalan.templates.Section
Creates a new instance of Section.
SimpleFlowLayout - class org.writersforge.catalan.layout.SimpleFlowLayout.
Very simple layout engine which flows all LayoutArea objects down and to the right.
SimpleFlowLayout() - Constructor for class org.writersforge.catalan.layout.SimpleFlowLayout
 
SingleLineCommentStripper - class org.writersforge.catalan.text.filters.SingleLineCommentStripper.
Text filter which removes single-line comments from the input text document.
SingleLineCommentStripper(String) - Constructor for class org.writersforge.catalan.text.filters.SingleLineCommentStripper
Creates a new instance of SingleLineCommentStripper.
SplitCommand - class org.writersforge.catalan.process.workers.text.SplitCommand.
Implementation of "split" command.
SplitCommand() - Constructor for class org.writersforge.catalan.process.workers.text.SplitCommand
Creates a new instance of SplitCommand.
SqlProcessor - class org.writersforge.catalan.transform.text.SqlProcessor.
Catalan processor for converting SQL DDL specifications into JavaBean objects.
SqlProcessor(Datum) - Constructor for class org.writersforge.catalan.transform.text.SqlProcessor
Creates a new instance of VelocityProcessor from the XML spec.
SqlProperties - class org.writersforge.catalan.process.workers.sql.SqlProperties.
Specialized properties container for SqlWorker.
SqlProperties(IWorkProperties) - Constructor for class org.writersforge.catalan.process.workers.sql.SqlProperties
Creates a new instance of SqlProperties.
SqlTable - class org.writersforge.catalan.process.workers.sql.SqlTable.
Simple data holder for SQL table info.
SqlTable() - Constructor for class org.writersforge.catalan.process.workers.sql.SqlTable
Creates a new instance of SqlTable.
SqlTable - class org.writersforge.catalan.transform.text.SqlTable.
Simple data holder for SQL table info.
SqlTable() - Constructor for class org.writersforge.catalan.transform.text.SqlTable
Creates a new instance of SqlTable.
SqlTable.Field - class org.writersforge.catalan.transform.text.SqlTable.Field.
A single field in an SQL table.
SqlTable.Field() - Constructor for class org.writersforge.catalan.transform.text.SqlTable.Field
Creates a new instance of Field.
SqlTable.Field(boolean, Map) - Constructor for class org.writersforge.catalan.transform.text.SqlTable.Field
Creates a new instance of Field with the specified primitive types policy.
SqlWorker - class org.writersforge.catalan.process.workers.sql.SqlWorker.
IWorker implementation which provides support for reading data from and writing data to an SQL database.
SqlWorker() - Constructor for class org.writersforge.catalan.process.workers.sql.SqlWorker
Creates a new instance of SqlWorker.
StripCommentsCommand - class org.writersforge.catalan.process.workers.text.StripCommentsCommand.
Implementation of "strip-comments" command.
StripCommentsCommand() - Constructor for class org.writersforge.catalan.process.workers.text.StripCommentsCommand
Creates a new instance of StripCommentsCommand.
StyleChain - class org.writersforge.catalan.layout.style.StyleChain.
Style aggregator.
StyleChain() - Constructor for class org.writersforge.catalan.layout.style.StyleChain
Creates a new empty instance of StyleChain.
StyleChain(StyleChain) - Constructor for class org.writersforge.catalan.layout.style.StyleChain
Creates a new instance of StyleChain using the copy as a template.
StyleMap - interface org.writersforge.catalan.layout.style.StyleMap.
Central access point for all layout styles.
StyleProcessor - class org.writersforge.catalan.transform.xform.StyleProcessor.
A Datum-only NodeProcessor for changing the formatting style of XML element names and attributes.
StyleProcessor(Datum) - Constructor for class org.writersforge.catalan.transform.xform.StyleProcessor
Creates a new instance of StyleProcessor from the XML spec.
StyleProcessor(String, PropertyName.PropertyStyle, Boolean) - Constructor for class org.writersforge.catalan.transform.xform.StyleProcessor
Creates a new instance of StyleProcessor.
StyledText - class org.writersforge.catalan.layout.StyledText.
A lightweight container for styled text.
StyledText() - Constructor for class org.writersforge.catalan.layout.StyledText
Creates a new default instance of StyledText.
StyledText(String) - Constructor for class org.writersforge.catalan.layout.StyledText
Creates a new instance of StyledText with the given unstyled text.
StyledText(TextStyle) - Constructor for class org.writersforge.catalan.layout.StyledText
Creates a new instance of StyledText with the given style.
StyledText(String, TextStyle) - Constructor for class org.writersforge.catalan.layout.StyledText
Creates a new instance of StyledText with the given text and style.
StyledText.Span - class org.writersforge.catalan.layout.StyledText.Span.
A single homogeneous span of markup style.
StyledText.Span(int, int, Markup[]) - Constructor for class org.writersforge.catalan.layout.StyledText.Span
Creates a new instance of Span.
selectAll() - Method in class org.writersforge.catalan.process.queue.NodeSelection
Adds a constraint to select all nodes.
selectEvens() - Method in class org.writersforge.catalan.process.queue.NodeSelection
Adds a constraint to select all even nodes.
selectIndexes(List) - Method in class org.writersforge.catalan.process.queue.NodeSelection
Runs the selection constraints against the given nodes.
selectOdds() - Method in class org.writersforge.catalan.process.queue.NodeSelection
Adds a constraint to select all odd nodes.
setAreas(int, LayoutArea) - Method in class org.writersforge.catalan.layout.Page
Indexed setter for property areas, the layout areas associated with this Page.
setAreas(LayoutArea[]) - Method in class org.writersforge.catalan.layout.Page
Setter for property areas, the layout areas associated with this Page.
setAtomic(boolean) - Method in class org.writersforge.catalan.layout.Constraint
Setter for property atomic, whether the area can be split or not.
setCheckCondition(String) - Method in class org.writersforge.catalan.process.workers.sql.Field
Assigns the CHECK condition for this field.
setCheckCondition(String) - Method in class org.writersforge.catalan.process.workers.sql.SqlTable
Assigns the table-level CHECK condition.
setCheckCondition(String) - Method in class org.writersforge.catalan.transform.text.SqlTable.Field
Assigns the CHECK condition for this field.
setCheckCondition(String) - Method in class org.writersforge.catalan.transform.text.SqlTable
Assigns the table-level CHECK condition.
setChildren(int, LayoutArea) - Method in class org.writersforge.catalan.layout.LayoutArea
Indexed setter for property children, the child layout areas.
setChildren(LayoutArea[]) - Method in class org.writersforge.catalan.layout.LayoutArea
Setter for property children, the child layout areas.
setChildren(int, LayoutArea) - Method in class org.writersforge.catalan.layout.LayoutGroup
Indexed setter for property children, the child layout areas.
setChildren(LayoutArea[]) - Method in class org.writersforge.catalan.layout.LayoutGroup
Setter for property children, the child layout areas.
setCurrentPage(int) - Method in class org.writersforge.catalan.templates.RenderTemplate
Sets the current page index
setCurrentPageNumber(int) - Method in class org.writersforge.catalan.layout.Book
Sets the current page number in this Book.
setCurrentRegion(Shape) - Method in class org.writersforge.catalan.layout.AbstractLayoutEngine
Assigns a clipping region for the current rendering context.
setCurrentRegion(Rectangle) - Method in class org.writersforge.catalan.layout.LayoutContext
Caches the current rendering region in the LayoutContext.
setCurrentRegion(Shape) - Method in interface org.writersforge.catalan.layout.LayoutEngine
Assigns a clipping region for the current rendering context.
setDdl(String) - Method in class org.writersforge.catalan.process.workers.sql.SqlTable
Sets the original SQL DDL for the table.
setDdl(String) - Method in class org.writersforge.catalan.transform.text.SqlTable
Sets the original SQL DDL for the table.
setDefaultProperties(IWorkProperties) - Method in class org.writersforge.catalan.process.workers.BaseJob
Initializes IWorker with default properties.
setDefaultProperties(IWorkProperties) - Method in class org.writersforge.catalan.process.workers.BaseWorker
Initializes IWorker with default properties.
setDefaultProperties(IWorkProperties) - Method in interface org.writersforge.catalan.process.workers.IWorker
Initializes IWorker with default properties.
setDefaultSize(Dimension) - Static method in class org.writersforge.catalan.layout.Constraint
Sets the default size for the preferred property.
setDefaultValue(String) - Method in class org.writersforge.catalan.process.workers.sql.Field
Assigns the default value for this field.
setDefaultValue(String) - Method in class org.writersforge.catalan.transform.text.SqlTable.Field
Assigns the default value for this field.
setDesc(String) - Method in class org.writersforge.catalan.process.workers.WorkMetadata
Assigns description metadata for the associated object.
setDistance(int) - Method in class org.writersforge.catalan.layout.Relation
Setter for property distance, a scalar measure to use with comparisons.
setEnd(int) - Method in class org.writersforge.catalan.layout.Markup
Setter for property end, the index of the last text character in the style span.
setEndToken(String) - Method in class org.writersforge.catalan.transform.text.VariableTextReplacer
Assigns the token used to end a variable.
setExtents(Rectangle) - Method in class org.writersforge.catalan.layout.LayoutArea
Setter for property extents, the actual extents for this area.
setFields(Field[]) - Method in class org.writersforge.catalan.process.workers.sql.SqlTable
Assigns all fields in this table.
setFields(SqlTable.Field[]) - Method in class org.writersforge.catalan.transform.text.SqlTable
Assigns all fields in this table.
setForeignKeys(Field[]) - Method in class org.writersforge.catalan.process.workers.sql.SqlTable
Assigns an array of all foreign key fields in this table.
setForeignKeys(SqlTable.Field[]) - Method in class org.writersforge.catalan.transform.text.SqlTable
Assigns an array of all foreign key fields in this table.
setFormat(String) - Method in class org.writersforge.catalan.GenericGenerator
Sets the rendering format: "PDF", "TEXT", or "HTML".
setHeight(int) - Method in class org.writersforge.catalan.layout.LayoutArea
Setter for property height, the final calculated height to render this area.
setHint(String) - Method in class org.writersforge.catalan.layout.LayoutArea
Setter for property hint, an optional field for descriptive info.
setIncludeDelimiters(boolean) - Method in class org.writersforge.catalan.transform.text.TokenSplitter
Sets the policy for including delimiters in the output.
setInputFiles(String[]) - Method in class org.writersforge.catalan.GenericGenerator
Sets the array of input file paths.
setInsets(Insets) - Method in class org.writersforge.catalan.layout.Page
Setter for property insets, the unwritable margins for this Page.
setLayout(LayoutEngine) - Method in class org.writersforge.catalan.templates.RenderTemplate
Assigns a LayoutEngine to this template.
setName(String) - Method in class org.writersforge.catalan.process.workers.WorkMetadata
Assigns name metadata for the associated object.
setName(String) - Method in class org.writersforge.catalan.process.workers.sql.Field
Assigns the name of this field.
setName(String) - Method in class org.writersforge.catalan.process.workers.sql.SqlTable
Sets the table name.
setName(String) - Method in class org.writersforge.catalan.transform.text.SqlTable.Field
Assigns the name of this field.
setName(String) - Method in class org.writersforge.catalan.transform.text.SqlTable
Sets the table name.
setNormalizeTokens(String[]) - Method in class org.writersforge.catalan.transform.text.Normalizer
Assigns a new set of tokens to normalize.
setNullable(boolean) - Method in class org.writersforge.catalan.process.workers.sql.Field
Assigns the nullability of this field.
setNullable(boolean) - Method in class org.writersforge.catalan.transform.text.SqlTable.Field
Assigns the nullability of this field.
setOptional(OptionalPropertyInfo[]) - Method in class org.writersforge.catalan.process.workers.WorkMetadata
Assigns metadata for all optional properties for the associated object.
setOptionalProperties(OptionalPropertyInfo[]) - Method in class org.writersforge.catalan.process.workers.BaseMetadataHolder
Assigns metadata for all optional properties in this command.
setOptionalProperties(OptionalPropertyInfo[]) - Method in class org.writersforge.catalan.process.workers.DefaultWorkerInfo
Assigns metadata for all optional properties in this worker.
setOuterRegion(Rectangle) - Method in class org.writersforge.catalan.layout.LayoutContext
Caches the top-level layout region in the LayoutContext.
setOutputFile(String) - Method in class org.writersforge.catalan.GenericGenerator
Sets the output file path.
setOutputStream(OutputStream) - Method in class org.writersforge.catalan.renderers.PdfRenderer
Sets a new OutputStream to render the next PDF file to.
setPadding(String) - Method in class org.writersforge.catalan.text.AsciiFieldManager
Assigns a new custom padding specification.
setPadding(String) - Method in class org.writersforge.catalan.transform.text.ToAsciiConverter
Assigns a custom padding string to use as a cycling overlay to all padded ('x') spans.
setPrimaryKeys(Field[]) - Method in class org.writersforge.catalan.process.workers.sql.SqlTable
Assigns an array of all primary key fields in this table.
setPrimaryKeys(SqlTable.Field[]) - Method in class org.writersforge.catalan.transform.text.SqlTable
Assigns an array of all primary key fields in this table.
setProperty(String, Object) - Method in class org.writersforge.catalan.layout.Book
Assigns a value to a generic property.
setRegistry(String) - Method in class org.writersforge.catalan.util.TransformTask
Sets the file name of the WorkerRegistry XML file.
setRelations(int, Relation) - Method in class org.writersforge.catalan.layout.Constraint
Indexed setter for property relations.
setRelations(Relation[]) - Method in class org.writersforge.catalan.layout.Constraint
Setter for property relations.
setRenderer(Renderer) - Method in class org.writersforge.catalan.GenericGenerator
Assigns the Renderer to use for creating the final output.
setReplaceCount(int) - Method in class org.writersforge.catalan.transform.text.TextReplacer
Assigns the maximum number of times per node that the processor will replace text.
setRequired(PropertyInfo[]) - Method in class org.writersforge.catalan.process.workers.WorkMetadata
Assigns metadata for all required properties for the associated object .
setRequiredProperties(PropertyInfo[]) - Method in class org.writersforge.catalan.process.workers.BaseMetadataHolder
Assigns metadata for all required properties in this command.
setRequiredProperties(PropertyInfo[]) - Method in class org.writersforge.catalan.process.workers.DefaultWorkerInfo
Assigns metadata for all required properties in this worker.
setResolver(String) - Method in class org.writersforge.catalan.transform.text.Normalizer
Assigns the text that the processor substitutes for normalized text.
setSqlType(String) - Method in class org.writersforge.catalan.process.workers.sql.Field
Assigns the SQL data type for this field.
setSqlType(String) - Method in class org.writersforge.catalan.transform.text.SqlTable.Field
Assigns the SQL data type for this field.
setStart(int) - Method in class org.writersforge.catalan.layout.Markup
Setter for property start, the index of the first text character in the style span.
setStartToken(String) - Method in class org.writersforge.catalan.transform.text.VariableTextReplacer
Assigns the token used to start a variable.
setStyle(FontStyle) - Method in class org.writersforge.catalan.layout.Markup
Setter for property style, the font for this markup section.
setStyledText(StyledText) - Method in class org.writersforge.catalan.layout.LayoutText
Setter for property styledText, the multi-style text content of this area.
setSwallowUndefined(boolean) - Method in class org.writersforge.catalan.transform.text.VariableTextReplacer
Determines the behavior for processing variables that aren't defined in lookup map.
setTemplateFile(String) - Method in class org.writersforge.catalan.GenericGenerator
Sets the file path for the template file.
setTerminalPriority(AlertPriority) - Method in class org.writersforge.catalan.process.workers.BaseWorker
Assigns the AlertPriority level at which this IWorker will throw an exception.
setText(String) - Method in class org.writersforge.catalan.layout.LayoutText
Setter for property text, the raw text content of this area.
setTransform(String) - Method in class org.writersforge.catalan.util.TransformTask
Sets the file name of the Transform XML file.
setUnique(boolean) - Method in class org.writersforge.catalan.process.workers.sql.Field
Assigns unique nature of field in its table.
setUnique(boolean) - Method in class org.writersforge.catalan.transform.text.SqlTable.Field
Assigns unique nature of field in its table.
setWidth(int) - Method in class org.writersforge.catalan.layout.LayoutArea
Setter for property width, the final calculated width to render this area.
setWriter(Writer) - Method in class org.writersforge.catalan.renderers.TextRenderer
Sets the output for the DTD content.
setX(int) - Method in class org.writersforge.catalan.layout.LayoutArea
Setter for property x, the final calculated x-axis origin to render this area.
setY(int) - Method in class org.writersforge.catalan.layout.LayoutArea
Setter for property y, the final calculated y-axis origin to render this area.
sortAreas(LayoutArea[]) - Method in class org.writersforge.catalan.templates.RenderTemplate
Rearranges the LayoutArea objects in a more linear order, gathering keep-with areas together and shuffling to make the layout more efficient.
start(List) - Method in class org.writersforge.catalan.transform.BaseNodeProcessor
Starts a new traversal.
start(List) - Method in class org.writersforge.catalan.transform.external.VelocityProcessor
Starts a new traversal.
start(List) - Method in class org.writersforge.catalan.transform.io.DebugProcessor
Starts a new traversal.
start(List) - Method in class org.writersforge.catalan.transform.io.ExportProcessor
Starts a new traversal.
start(List) - Method in class org.writersforge.catalan.transform.text.Concatenator
Starts a new traversal.
start(List) - Method in class org.writersforge.catalan.transform.xform.CopyProcessor
Starts a new traversal.
start(List) - Method in class org.writersforge.catalan.transform.xform.InsertProcessor
Starts a new traversal.
start(List) - Method in class org.writersforge.catalan.transform.xform.MoveProcessor
Starts a new traversal.
start(List) - Method in class org.writersforge.catalan.transform.xml.ObjectToDatum
Starts a new traversal.
startBook(Book) - Method in class org.writersforge.catalan.renderers.PdfRenderer
Performs any special initialization that the Renderer must do at the very beginning of the rendering process.
startBook(Book) - Method in class org.writersforge.catalan.renderers.Renderer
Performs any special initialization that the Renderer must do at the very beginning of the rendering process.
startPage(Page) - Method in class org.writersforge.catalan.renderers.PdfRenderer
Performs any special initialization that the Renderer must do before every Page.
startPage(Page) - Method in class org.writersforge.catalan.renderers.Renderer
Performs any special initialization that the Renderer must do before every Page.
storeText(Object, String) - Method in class org.writersforge.catalan.process.workers.text.BaseTextCommand
Assigns the text to the node.
stringWidth(String) - Method in class org.writersforge.catalan.layout.style.FontStyleMetrics
Estimates the width of the given string if rendered in this style.

T

TITLE - Static variable in class org.writersforge.catalan.text.filters.CaseFilter
Case style for capitalizing the first letter of every word.
TRAILING_ATTRACTOR_EDGE_MASK - Static variable in class org.writersforge.catalan.layout.Relation
Relate to trailing edge in attractor
TRAILING_SATELLITE_EDGE_MASK - Static variable in class org.writersforge.catalan.layout.Relation
Relate to trailing edge in satellite
TableOp - class org.writersforge.catalan.templates.generic.TableOp.
A template op wrapper for <table>.
TableOp(Datum, StyleMap) - Constructor for class org.writersforge.catalan.templates.generic.TableOp
Creates a new instance of TableOp.
TableOp(Datum, StyleMap, StyleChain) - Constructor for class org.writersforge.catalan.templates.generic.TableOp
Creates a new instance of TableOp with an optional StyleChain fallback.
TagProcessor - class org.writersforge.catalan.transform.xform.TagProcessor.
A Datum-only NodeProcessor for recursively adding attribute tags to sets of sibling elements.
TagProcessor(Datum) - Constructor for class org.writersforge.catalan.transform.xform.TagProcessor
Creates a new instance of TagProcessor from the XML spec.
TagProcessor(String, String[], String, String, int) - Constructor for class org.writersforge.catalan.transform.xform.TagProcessor
Creates a new instance of TagProcessor.
TextOp - class org.writersforge.catalan.templates.generic.TextOp.
A template op describing a run of renderable text.
TextOp(Datum, StyleMap) - Constructor for class org.writersforge.catalan.templates.generic.TextOp
Creates a new instance of TextOp.
TextOp(Datum, StyleMap, StyleChain) - Constructor for class org.writersforge.catalan.templates.generic.TextOp
Creates a new instance of TextOp with an optional StyleChain fallback.
TextProcessor - class org.writersforge.catalan.transform.text.TextProcessor.
The shared base class for all Catalan ASCII text processors.
TextProcessor() - Constructor for class org.writersforge.catalan.transform.text.TextProcessor
Creates a new instance of TextProcessor.
TextProperties - class org.writersforge.catalan.process.workers.text.TextProperties.
Specialized properties container for TextWorker.
TextProperties(IWorkProperties) - Constructor for class org.writersforge.catalan.process.workers.text.TextProperties
Creates a new instance of TextProperties.
TextRenderer - class org.writersforge.catalan.renderers.TextRenderer.
Generates a collection of ASCII text files from one or more Page objects created by a RenderTemplate class.
TextRenderer() - Constructor for class org.writersforge.catalan.renderers.TextRenderer
 
TextReplacer - class org.writersforge.catalan.text.filters.TextReplacer.
Text filter which substitutes one static text string for another.
TextReplacer(String, String) - Constructor for class org.writersforge.catalan.text.filters.TextReplacer
Creates a new instance of TextReplacer.
TextReplacer(String, String, int) - Constructor for class org.writersforge.catalan.text.filters.TextReplacer
Creates a new instance of TextReplacer with a maximum iteration count.
TextReplacer - class org.writersforge.catalan.transform.text.TextReplacer.
A text processor which performs a simple search and replace action.
TextReplacer(Datum) - Constructor for class org.writersforge.catalan.transform.text.TextReplacer
Creates a new instance of TextReplacer from the XML spec.
TextReplacer(String, String) - Constructor for class org.writersforge.catalan.transform.text.TextReplacer
Creates a new instance of TextReplacer.
TextResolver - class org.writersforge.catalan.text.filters.TextResolver.
Text filter which performs variable lookup and substitution from a Map of values.
TextResolver(Map, boolean) - Constructor for class org.writersforge.catalan.text.filters.TextResolver
Creates a new instance of TextResolver with default token delimiters "${" and "}".
TextResolver(Map, String, String, boolean) - Constructor for class org.writersforge.catalan.text.filters.TextResolver
Creates a new instance of TextResolver with static start and end token delimiters.
TextResolver(Map, String, boolean) - Constructor for class org.writersforge.catalan.text.filters.TextResolver
Creates a new instance of TextResolver with static start and end token delimiters.
TextStyle - interface org.writersforge.catalan.layout.style.TextStyle.
The size and alignment info for a block of text.
TextToLattice - class org.writersforge.catalan.transform.xml.TextToLattice.
A conversion processor which turns simple ASCII text documents into Lattice XML documents.
TextToLattice(Datum) - Constructor for class org.writersforge.catalan.transform.xml.TextToLattice
Creates a new instance of TextToLattice from the XML spec.
TextToLattice(boolean) - Constructor for class org.writersforge.catalan.transform.xml.TextToLattice
Creates a new instance of TextToLattice.
TextToXmlCommand - class org.writersforge.catalan.process.workers.text.TextToXmlCommand.
Implementation of "text-to-xml" command.
TextToXmlCommand() - Constructor for class org.writersforge.catalan.process.workers.text.TextToXmlCommand
Creates a new instance of TextToXmlCommand.
TextWorker - class org.writersforge.catalan.process.workers.text.TextWorker.
IWorker implementation which provides support for manipulating text.
TextWorker() - Constructor for class org.writersforge.catalan.process.workers.text.TextWorker
 
ToAsciiCommand - class org.writersforge.catalan.process.workers.text.ToAsciiCommand.
Implementation of "to-ascii" command.
ToAsciiCommand() - Constructor for class org.writersforge.catalan.process.workers.text.ToAsciiCommand
Creates a new instance of ToAsciiCommand.
ToAsciiConverter - class org.writersforge.catalan.transform.text.ToAsciiConverter.
A packed ASCII field processor which explodes a packed ASCII data node into a collection of Java objects, or vice versa.
ToAsciiConverter(Datum) - Constructor for class org.writersforge.catalan.transform.text.ToAsciiConverter
Creates a new instance of ToAsciiConverter from the XML spec.
ToAsciiConverter(String) - Constructor for class org.writersforge.catalan.transform.text.ToAsciiConverter
Creates a new instance of AsciiConverter.
ToAttributeProcessor - class org.writersforge.catalan.transform.xform.ToAttributeProcessor.
A Datum-only NodeProcessor for converting element content into attribute content.
ToAttributeProcessor(Datum) - Constructor for class org.writersforge.catalan.transform.xform.ToAttributeProcessor
Creates a new instance of ToAttributeProcessor from the XML spec.
ToAttributeProcessor(String, String) - Constructor for class org.writersforge.catalan.transform.xform.ToAttributeProcessor
Creates a new instance of ToAttributeProcessor.
ToElementProcessor - class org.writersforge.catalan.transform.xform.ToElementProcessor.
A Datum-only NodeProcessor for converting attributes into element content.
ToElementProcessor(Datum) - Constructor for class org.writersforge.catalan.transform.xform.ToElementProcessor
Creates a new instance of ToElementProcessor from the XML spec.
ToElementProcessor(String, String, int, String) - Constructor for class org.writersforge.catalan.transform.xform.ToElementProcessor
Creates a new instance of ToElementProcessor.
TokenSplitter - class org.writersforge.catalan.text.extractors.TokenSplitter.
Text splitter which splits documents each time it encounters a static token.
TokenSplitter(String[], boolean) - Constructor for class org.writersforge.catalan.text.extractors.TokenSplitter
Creates a new instance of TokenSplitter.
TokenSplitter - class org.writersforge.catalan.transform.text.TokenSplitter.
A text processor which breaks apart its String contents into smaller parts, based on its own parameters.
TokenSplitter(Datum) - Constructor for class org.writersforge.catalan.transform.text.TokenSplitter
Creates a new instance of TokenSplitter from the XML spec.
TokenSplitter(String[]) - Constructor for class org.writersforge.catalan.transform.text.TokenSplitter
Creates a new instance of TokenSplitter.
TokenizeCommand - class org.writersforge.catalan.process.workers.text.TokenizeCommand.
Implementation of "tokenize" command.
TokenizeCommand() - Constructor for class org.writersforge.catalan.process.workers.text.TokenizeCommand
Creates a new instance of TokenizeCommand.
TransformTask - class org.writersforge.catalan.util.TransformTask.
Ant task for running the Transformer front end.
TransformTask() - Constructor for class org.writersforge.catalan.util.TransformTask
 
TransformTask.Input - class org.writersforge.catalan.util.TransformTask.Input.
JavaBean to encapsulate <input> element inside <catalan> Ant task.
TransformTask.Input() - Constructor for class org.writersforge.catalan.util.TransformTask.Input
 
Transformer - class org.writersforge.catalan.transform.Transformer.
Deprecated.  
Transformer(Datum) - Constructor for class org.writersforge.catalan.transform.Transformer
Deprecated. Creates a new instance of Transformer.
Transformer(Datum, ProcessorRegistry) - Constructor for class org.writersforge.catalan.transform.Transformer
Deprecated. Creates a new instance of Transformer with a custom mapping registry.
TypeMap - class org.writersforge.catalan.process.workers.sql.TypeMap.
Encapsulates a mapping between an SQL type and a Java type.
TypeMap(String, String) - Constructor for class org.writersforge.catalan.process.workers.sql.TypeMap
Creates a new instance of TypeMap.
toString() - Method in class org.writersforge.catalan.layout.Constraint
Creates a String representation of this Constraint
toString() - Method in class org.writersforge.catalan.layout.LayoutArea
Converts the area object into String form.
toString() - Method in class org.writersforge.catalan.layout.LayoutGroup
Converts the area object into String form.
toString() - Method in class org.writersforge.catalan.layout.LayoutPadding
Converts the area object into String form.
toString() - Method in class org.writersforge.catalan.layout.LayoutText
Converts the area object into String form.
toString() - Method in class org.writersforge.catalan.layout.Markup
Creates a String version of this object
toString() - Method in class org.writersforge.catalan.layout.Relation
Returns this object as a String
toString() - Method in class org.writersforge.catalan.layout.style.FontStyleMetrics
Returns this object as a String
toString() - Method in class org.writersforge.catalan.process.ProcessException
Converts object into String form.
toString() - Method in class org.writersforge.catalan.process.properties.BaseWorkProperties
Converts object to String form.
toString() - Method in class org.writersforge.catalan.process.properties.ChainedProperties
Converts object to String form.
toString() - Method in class org.writersforge.catalan.process.queue.Alert
Converts this object into String form.
toString() - Method in class org.writersforge.catalan.process.queue.AlertPriority
Converts this object into String form.
toString() - Method in class org.writersforge.catalan.transform.text.FromAsciiConverter
Convert this object to a String value.
toString() - Method in class org.writersforge.catalan.transform.text.Normalizer
Convert this object to a String value.
toString() - Method in class org.writersforge.catalan.transform.text.TextReplacer
Convert this object to a String value.
toString() - Method in class org.writersforge.catalan.transform.text.ToAsciiConverter
Convert this object to a String value.
toString() - Method in class org.writersforge.catalan.transform.text.TokenSplitter
Convert this object to a String value.
toString() - Method in class org.writersforge.catalan.transform.text.VariableTextReplacer
Convert this object to a String value.
toString() - Method in class org.writersforge.catalan.transform.xml.ObjectToDatum
Convert this object to a String value.
transformNode(Datum, Datum) - Method in class org.writersforge.catalan.transform.xform.CopyProcessor
Performs an in-place transformation on the supplied Datum tree.
transformNode(Datum, Datum) - Method in class org.writersforge.catalan.transform.xform.DeleteProcessor
Performs an in-place transformation on the supplied Datum tree.
transformNode(Datum, Datum) - Method in class org.writersforge.catalan.transform.xform.InlineProcessor
Performs an in-place transformation on the supplied Datum tree.
transformNode(Datum, Datum) - Method in class org.writersforge.catalan.transform.xform.InsertProcessor
Performs an in-place transformation on the supplied Datum tree.
transformNode(Datum, Datum) - Method in class org.writersforge.catalan.transform.xform.MoveProcessor
Performs an in-place transformation on the supplied Datum tree.
transformNode(Datum, Datum) - Method in class org.writersforge.catalan.transform.xform.RenameProcessor
Performs an in-place transformation on the supplied Datum tree.
transformNode(Datum, Datum) - Method in class org.writersforge.catalan.transform.xform.StyleProcessor
Performs an in-place transformation on the supplied Datum tree.
transformNode(Datum, Datum) - Method in class org.writersforge.catalan.transform.xform.TagProcessor
Performs an in-place transformation on the supplied Datum tree.
transformNode(Datum, Datum) - Method in class org.writersforge.catalan.transform.xform.ToAttributeProcessor
Performs an in-place transformation on the supplied Datum tree.
transformNode(Datum, Datum) - Method in class org.writersforge.catalan.transform.xform.ToElementProcessor
Performs an in-place transformation on the supplied Datum tree.
transformNode(Datum, Datum) - Method in class org.writersforge.catalan.transform.xform.WrapProcessor
Performs an in-place transformation on the supplied Datum tree.
transformNode(Datum, Datum) - Method in class org.writersforge.catalan.transform.xform.XFormProcessor
Performs an in-place transformation on the supplied Datum tree.

U

UNKNOWN_TYPE - Static variable in class org.writersforge.catalan.process.workers.partition.PartitionIndexer
PartitionRange type for unrecognized partitions.
UPPER - Static variable in class org.writersforge.catalan.text.filters.CaseFilter
Case style for all upper case.

V

VERTICAL - Static variable in class org.writersforge.catalan.layout.LayoutGroup
Group child areas in a vertical direction
VERTICAL_MASK - Static variable in class org.writersforge.catalan.layout.Relation
Apply relation along vertical axis
VariableTextReplacer - class org.writersforge.catalan.transform.text.VariableTextReplacer.
A text processor which performs dynamic text replacement by looking up specially formatted variables and resolving them against a Map of variable names to text values.
VariableTextReplacer(Datum) - Constructor for class org.writersforge.catalan.transform.text.VariableTextReplacer
Creates a new instance of VariableTextReplacer from the XML spec.
VariableTextReplacer(Map) - Constructor for class org.writersforge.catalan.transform.text.VariableTextReplacer
Creates a new instance of VariableTextReplacer.
VelocityProcessor - class org.writersforge.catalan.transform.external.VelocityProcessor.
An external tools wrapper for processing Velocity template with Catalan.
VelocityProcessor(Datum) - Constructor for class org.writersforge.catalan.transform.external.VelocityProcessor
Creates a new instance of VelocityProcessor from the XML spec.
VelocityProperties - class org.writersforge.catalan.process.workers.velocity.VelocityProperties.
Specialized properties container for VelocityWorker.
VelocityProperties(IWorkProperties) - Constructor for class org.writersforge.catalan.process.workers.velocity.VelocityProperties
Creates a new instance of VelocityProperties.
VelocityRunner - class org.writersforge.catalan.process.workers.velocity.VelocityRunner.
Helper class to abstract calls to the Velocity API out of the VelocityProcessor class.
VelocityRunner() - Constructor for class org.writersforge.catalan.process.workers.velocity.VelocityRunner
 
VelocityRunner - class org.writersforge.catalan.transform.external.VelocityRunner.
Helper class to abstract calls to the Velocity API out of the VelocityProcessor class.
VelocityRunner() - Constructor for class org.writersforge.catalan.transform.external.VelocityRunner
 
VelocityWorker - class org.writersforge.catalan.process.workers.velocity.VelocityWorker.
IWorker implementation which provides support for Jakarta Velocity template processing.
VelocityWorker() - Constructor for class org.writersforge.catalan.process.workers.velocity.VelocityWorker
 
validateProperties(IWorkProperties, boolean) - Method in class org.writersforge.catalan.process.workers.BaseMetadataHolder
Validate properties against IWorkMetadata.
validateProperties(IWorkProperties, boolean) - Method in interface org.writersforge.catalan.process.workers.IMetadataHolder
Validate properties against IWorkMetadata.
validateType(PropertyInfo, String, Object) - Method in class org.writersforge.catalan.process.workers.BaseMetadataHolder
Make sure property type matches any of the required types.
validateType(PropertyInfo, String, Object) - Method in interface org.writersforge.catalan.process.workers.IMetadataHolder
Make sure property type matches any of the required types.

W

WARNING - Static variable in class org.writersforge.catalan.process.queue.AlertPriority
A WARNING Alert, signalling that the transform encountered a problem, but recovered; results should be valid and complete.
WRAP_CHARACTER - Static variable in interface org.writersforge.catalan.layout.style.TextStyle
Text should be wrapped at the character boundary
WRAP_ENUM - Static variable in interface org.writersforge.catalan.layout.style.TextStyle
Enumeration of text wrapping
WRAP_LINE - Static variable in interface org.writersforge.catalan.layout.style.TextStyle
Text should be wrapped at the line boundary
WRAP_NEVER - Static variable in interface org.writersforge.catalan.layout.style.TextStyle
Text should not be wrapped at all
WRAP_PHRASE - Static variable in interface org.writersforge.catalan.layout.style.TextStyle
Text should be wrapped at the phrase boundary
WRAP_SENTENCE - Static variable in interface org.writersforge.catalan.layout.style.TextStyle
Text should be wrapped at the sentence boundary
WRAP_WORD - Static variable in interface org.writersforge.catalan.layout.style.TextStyle
Text should be wrapped at the word boundary
WorkMetadata - class org.writersforge.catalan.process.workers.WorkMetadata.
Wrapper around worker metadata.
WorkMetadata(String, String) - Constructor for class org.writersforge.catalan.process.workers.WorkMetadata
Creates a new instance of WorkMetadata with no property metadata.
WorkMetadata(String, String, PropertyInfo[], OptionalPropertyInfo[]) - Constructor for class org.writersforge.catalan.process.workers.WorkMetadata
Creates a new instance of WorkMetadata with property metadata.
WorkProcessor - class org.writersforge.catalan.process.WorkProcessor.
Top level driver for running worker processes.
WorkProcessor(String[]) - Constructor for class org.writersforge.catalan.process.WorkProcessor
Creates a new instance of WorkProcessor, using paths to XML versions of the workspace and registry.
WorkProcessor(IWorkspace) - Constructor for class org.writersforge.catalan.process.WorkProcessor
Creates a new instance of WorkProcessor from instantiated workspace and registry objects.
WorkPropertyException - exception org.writersforge.catalan.process.properties.WorkPropertyException.
An exception for IWorker initialization problems.
WorkPropertyException(String) - Constructor for class org.writersforge.catalan.process.properties.WorkPropertyException
Creates a new instance of WorkPropertyException.
WorkPropertyException(String, Throwable) - Constructor for class org.writersforge.catalan.process.properties.WorkPropertyException
Creates a new instance of WorkPropertyException.
WorkerRegistry - class org.writersforge.catalan.process.workers.WorkerRegistry.
Container for all instantiated IWorker objects.
WorkerRegistry() - Constructor for class org.writersforge.catalan.process.workers.WorkerRegistry
Creates a new instance of WorkerRegistry.
WorkspaceException - exception org.writersforge.catalan.process.workspace.WorkspaceException.
An exception for IWorkspace problems.
WorkspaceException(String) - Constructor for class org.writersforge.catalan.process.workspace.WorkspaceException
Creates a new instance of WorkspaceException.
WorkspaceException(String, Throwable) - Constructor for class org.writersforge.catalan.process.workspace.WorkspaceException
Creates a new instance of WorkspaceException.
WrapProcessor - class org.writersforge.catalan.transform.xform.WrapProcessor.
A Datum-only NodeProcessor for increasing the level of nesting for the queried set of elements.
WrapProcessor(Datum) - Constructor for class org.writersforge.catalan.transform.xform.WrapProcessor
Creates a new instance of WrapProcessor from the XML spec.
WrapProcessor(String, String) - Constructor for class org.writersforge.catalan.transform.xform.WrapProcessor
Creates a new instance of WrapProcessor.
wrapText(int) - Method in class org.writersforge.catalan.layout.StyledText
Performs line-wrapping on the text contents.
wrapText(int, int, int) - Method in class org.writersforge.catalan.layout.StyledText
Performs line-wrapping on the text contents.

X

XFormProcessor - class org.writersforge.catalan.transform.xform.XFormProcessor.
Common base class for all XForm operations.
XFormProcessor(String) - Constructor for class org.writersforge.catalan.transform.xform.XFormProcessor
Creates a new instance of XFormProcessor.
XmlBuilderWorker - class org.writersforge.catalan.process.workers.xml.XmlBuilderWorker.
IWorker implementation which provides support for building XML documents from a queue of primitive data objects.
XmlBuilderWorker() - Constructor for class org.writersforge.catalan.process.workers.xml.XmlBuilderWorker
 
XmlCommonProperties - class org.writersforge.catalan.process.workers.xml.XmlCommonProperties.
Specialized properties container for XmlWorker.
XmlCommonProperties(IWorkProperties) - Constructor for class org.writersforge.catalan.process.workers.xml.XmlCommonProperties
Creates a new instance of XmlCommonProperties.
XmlCopyCommand - class org.writersforge.catalan.process.workers.xml.XmlCopyCommand.
Implementation of "copy" command.
XmlCopyCommand() - Constructor for class org.writersforge.catalan.process.workers.xml.XmlCopyCommand
Creates a new instance of XmlCopyCommand.
XmlExploderCommand - class org.writersforge.catalan.process.workers.xml.XmlExploderCommand.
Implementation of "exploder" command.
XmlExploderCommand() - Constructor for class org.writersforge.catalan.process.workers.xml.XmlExploderCommand
Creates a new instance of XmlExploderCommand.
XmlInlineCommand - class org.writersforge.catalan.process.workers.xml.XmlInlineCommand.
Implementation of "inline" command.
XmlInlineCommand() - Constructor for class org.writersforge.catalan.process.workers.xml.XmlInlineCommand
Creates a new instance of XmlInlineCommand.
XmlInsertCommand - class org.writersforge.catalan.process.workers.xml.XmlInsertCommand.
Implementation of "insert" command.
XmlInsertCommand() - Constructor for class org.writersforge.catalan.process.workers.xml.XmlInsertCommand
Creates a new instance of XmlInsertCommand.
XmlJob - class org.writersforge.catalan.process.workers.XmlJob.
A BaseJob based on an XML description of embedded Workers.
XmlJob(Datum, WorkerRegistry) - Constructor for class org.writersforge.catalan.process.workers.XmlJob
Creates a new instance of XmlJob.
XmlProperties - class org.writersforge.catalan.process.properties.XmlProperties.
IWorkProperties which exports XML attributes as properties.
XmlProperties(Datum) - Constructor for class org.writersforge.catalan.process.properties.XmlProperties
Creates a new instance of XmlProperties.
XmlPropertyManager - class org.writersforge.catalan.process.properties.XmlPropertyManager.
Utility class for converting XML data into the proper Java objects.
XmlPropertyManager() - Constructor for class org.writersforge.catalan.process.properties.XmlPropertyManager
 
XmlRenameCommand - class org.writersforge.catalan.process.workers.xml.XmlRenameCommand.
Implementation of "rename" command.
XmlRenameCommand() - Constructor for class org.writersforge.catalan.process.workers.xml.XmlRenameCommand
Creates a new instance of XmlRenameCommand.
XmlSelectProcessor - class org.writersforge.catalan.transform.xml.XmlSelectProcessor.
Composite NodeProcessor which can select a subset of the current tree with a Bellows path, and only operate on that subset.
XmlSelectProcessor(Datum, ProcessorRegistry) - Constructor for class org.writersforge.catalan.transform.xml.XmlSelectProcessor
Creates a new instance of XmlSelectProcessor from the XML spec.
XmlSelectProcessor(NodeProcessor[], String) - Constructor for class org.writersforge.catalan.transform.xml.XmlSelectProcessor
Creates a new instance of XmlSelectProcessor.
XmlStyleCommand - class org.writersforge.catalan.process.workers.xml.XmlStyleCommand.
Implementation of "style" command.
XmlStyleCommand() - Constructor for class org.writersforge.catalan.process.workers.xml.XmlStyleCommand
Creates a new instance of XmlStyleCommand.
XmlTagCommand - class org.writersforge.catalan.process.workers.xml.XmlTagCommand.
Implementation of "tag" command.
XmlTagCommand() - Constructor for class org.writersforge.catalan.process.workers.xml.XmlTagCommand
Creates a new instance of XmlTagCommand.
XmlToAttributeCommand - class org.writersforge.catalan.process.workers.xml.XmlToAttributeCommand.
Implementation of "to-attribute" command.
XmlToAttributeCommand() - Constructor for class org.writersforge.catalan.process.workers.xml.XmlToAttributeCommand
Creates a new instance of XmlToAttributeCommand.
XmlToBean - class org.writersforge.catalan.transform.xml.XmlToBean.
A processor which converts each Datum input node into a JavaBean.
XmlToBean() - Constructor for class org.writersforge.catalan.transform.xml.XmlToBean
Creates a new instance of BeanToXml.
XmlToBeanCommand - class org.writersforge.catalan.process.workers.javabean.XmlToBeanCommand.
Implementation of "xml-to-bean" command.
XmlToBeanCommand() - Constructor for class org.writersforge.catalan.process.workers.javabean.XmlToBeanCommand
Creates a new instance of XmlToBeanCommand.
XmlToElementCommand - class org.writersforge.catalan.process.workers.xml.XmlToElementCommand.
Implementation of "to-element" command.
XmlToElementCommand() - Constructor for class org.writersforge.catalan.process.workers.xml.XmlToElementCommand
Creates a new instance of XmlToElementCommand.
XmlToHtml - class org.writersforge.catalan.transform.xml.XmlToHtml.
Text or XML processor for marking up XML content with HTML formatting.
XmlToHtml() - Constructor for class org.writersforge.catalan.transform.xml.XmlToHtml
 
XmlToHtmlCommand - class org.writersforge.catalan.process.workers.html.XmlToHtmlCommand.
Command for "xml-to-html".
XmlToHtmlCommand() - Constructor for class org.writersforge.catalan.process.workers.html.XmlToHtmlCommand
Creates a new instance of XmlToHtmlCommand.
XmlWorker - class org.writersforge.catalan.process.workers.xml.XmlWorker.
IWorker implementation which provides support for loading, creating, and modifying XML documents.
XmlWorker() - Constructor for class org.writersforge.catalan.process.workers.xml.XmlWorker
 
XmlWorkerRegistry - class org.writersforge.catalan.process.workers.XmlWorkerRegistry.
WorkerRegistry that loads itself from an XML specification.
XmlWorkerRegistry() - Constructor for class org.writersforge.catalan.process.workers.XmlWorkerRegistry
 
XmlWorkspace - class org.writersforge.catalan.process.workspace.XmlWorkspace.
IWorkspace backed by an XML document.
XmlWorkspace(String) - Constructor for class org.writersforge.catalan.process.workspace.XmlWorkspace
Creates a new instance of XmlWorkspace using a path to the XML document.
XmlWorkspace(Datum) - Constructor for class org.writersforge.catalan.process.workspace.XmlWorkspace
Creates a new instance of XmlWorkspace from the given XML document.
XmlWrapCommand - class org.writersforge.catalan.process.workers.xml.XmlWrapCommand.
Implementation of "wrap" command.
XmlWrapCommand() - Constructor for class org.writersforge.catalan.process.workers.xml.XmlWrapCommand
Creates a new instance of XmlWrapCommand.

A B C D E F G H I J L M N O P Q R S T U V W X