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

A

APP_NAME - Static variable in class org.xfp.XFP

Application name.

APP_UNIXNAME - Static variable in class org.xfp.XFP

Application UNIX name.

AntTask - class org.xfp.filters.AntTask.

Executes an Ant task.

AntTask() - Constructor for class org.xfp.filters.AntTask

AttributeContainer - class org.xfp.AttributeContainer.

Base class for XFP entities that contain attributes.

AttributeContainer() - Constructor for class org.xfp.AttributeContainer

AttributeDefinition - class org.xfp.AttributeDefinition.

Attribute definition.

AttributeDefinition(String, Class, Properties) - Constructor for class org.xfp.AttributeDefinition

Sole constructor.

add(Exception) - Method in class org.xfp.MultiException

B

BREAK - Static variable in class org.xfp.Filter.OnErrorEnum

break branch execution (by skipping all nested filters) and jump to the next filter branch

BREAK - Static variable in class org.xfp.Filter.OnLoopErrorEnum

break the loop (similar to the java 'break' keyword)

BREAK_VALUE - Static variable in class org.xfp.Filter.OnErrorEnum

BREAK_VALUE - Static variable in class org.xfp.Filter.OnLoopErrorEnum

BeanCollectionSorter - class org.xfp.filters.beans.BeanCollectionSorter.

Sorts a Collection of JavaBeans using the value of the specified property.

BeanCollectionSorter() - Constructor for class org.xfp.filters.beans.BeanCollectionSorter

BeanInstance - class org.xfp.filters.beans.BeanInstance.

Instantiates a JavaBean and sets its properties.

BeanInstance() - Constructor for class org.xfp.filters.beans.BeanInstance

BeanXMLDecoder - class org.xfp.filters.beans.BeanXMLDecoder.

Reads a textual representation of a JavaBean.

BeanXMLDecoder() - Constructor for class org.xfp.filters.beans.BeanXMLDecoder

BeanXMLEncoder - class org.xfp.filters.beans.BeanXMLEncoder.

Generates a textual representation of a JavaBean.

BeanXMLEncoder() - Constructor for class org.xfp.filters.beans.BeanXMLEncoder

ByteArrayToInputStream - class org.xfp.filters.convert.ByteArrayToInputStream.

Converts an byte array to an InputStream.

ByteArrayToInputStream() - Constructor for class org.xfp.filters.convert.ByteArrayToInputStream

C

COMPONENT_NAME - Static variable in class org.xfp.engine.Engine

CONTINUE - Static variable in class org.xfp.Filter.OnLoopErrorEnum

continue with the next iteration (similar to the java 'continue' keyword)

CONTINUE_VALUE - Static variable in class org.xfp.Filter.OnLoopErrorEnum

CheckAlreadyFiltered - class org.xfp.filters.util.CheckAlreadyFiltered.

Checks if input data has been filtered in the previous Pipeline execution.

CheckAlreadyFiltered() - Constructor for class org.xfp.filters.util.CheckAlreadyFiltered

CodecBinaryDecoder - class org.xfp.filters.codec.CodecBinaryDecoder.

Wrapper to the BinaryDecoder's in the Jakarta Commons Codec package.

CodecBinaryDecoder() - Constructor for class org.xfp.filters.codec.CodecBinaryDecoder

CodecBinaryEncoder - class org.xfp.filters.codec.CodecBinaryEncoder.

Wrapper to the BinaryEncoder's in the Jakarta Commons Codec package.

CodecBinaryEncoder() - Constructor for class org.xfp.filters.codec.CodecBinaryEncoder

CodecStringDecoder - class org.xfp.filters.codec.CodecStringDecoder.

Wrapper to the StringDecoder's in the Jakarta Commons Codec package.

CodecStringDecoder() - Constructor for class org.xfp.filters.codec.CodecStringDecoder

CodecStringEncoder - class org.xfp.filters.codec.CodecStringEncoder.

Wrapper to the StringEncoder's in the Jakarta Commons Codec package.

CodecStringEncoder() - Constructor for class org.xfp.filters.codec.CodecStringEncoder

commonSchema - Static variable in class org.xfp.engine.XMLUtils

W3C Schema for Common types

configureAttributes(Node, XPathEvaluator) - Method in class org.xfp.AttributeContainer

Assigns attribute definitions to this AttributeContainer reading from XML configuration.

convert(Class, Object) - Method in class org.xfp.engine.ISO8601DateConverter

Convert the specified input object into an output object of the specified type.

createMessage(String, List, String, String) - Method in class org.xfp.components.SMTPHelper

Creates a message.

D

DOMParser - class org.xfp.filters.xml.DOMParser.

Parses XML data into a DOM using the JAXP API.

DOMParser() - Constructor for class org.xfp.filters.xml.DOMParser

DateGenerator - class org.xfp.filters.DateGenerator.

Generates a date in the specified string format.

DateGenerator() - Constructor for class org.xfp.filters.DateGenerator

DeleteFile - class org.xfp.filters.file.DeleteFile.

Deletes a file.

DeleteFile() - Constructor for class org.xfp.filters.file.DeleteFile

dispose() - Method in class org.xfp.components.FTPClientComponent

dispose() - Method in class org.xfp.engine.Engine

Dispose.

disposeAttributes() - Method in class org.xfp.AttributeContainer

Releases attributes.

E

EXIT - Static variable in class org.xfp.Filter.OnErrorEnum

exit Pipeline execution

EXIT_VALUE - Static variable in class org.xfp.Filter.OnErrorEnum

Engine - class org.xfp.engine.Engine.

The XFP Engine executes Task's at scheduled time.

Engine() - Constructor for class org.xfp.engine.Engine

Sole constructor.

engineSchema - Static variable in class org.xfp.engine.XMLUtils

W3C Schema for Engine documents

execute() - Method in class org.xfp.Pipeline

Runs this Pipeline.

execute() - Method in class org.xfp.filters.AntTask

execute() - Method in class org.xfp.filters.DateGenerator

Executes this filter.

execute() - Method in class org.xfp.filters.HTTPGet

Executes this filter.

execute(String) - Method in class org.xfp.filters.HTTPGet

Executes this filter.

execute(URL) - Method in class org.xfp.filters.HTTPGet

Executes this filter.

execute(FTPFile) - Method in class org.xfp.filters.PatternMatcher

Executes this filter.

execute(String) - Method in class org.xfp.filters.PatternMatcher

Executes this filter.

execute(Collection) - Method in class org.xfp.filters.beans.BeanCollectionSorter

Executes this filter.

execute() - Method in class org.xfp.filters.beans.BeanInstance

Executes this filter.

execute(Class) - Method in class org.xfp.filters.beans.BeanInstance

Executes this filter.

execute(String) - Method in class org.xfp.filters.beans.BeanInstance

Executes this filter.

execute(InputStream) - Method in class org.xfp.filters.beans.BeanXMLDecoder

Executes this filter.

execute(Object) - Method in class org.xfp.filters.beans.BeanXMLEncoder

Executes this filter.

execute(byte[]) - Method in class org.xfp.filters.codec.CodecBinaryDecoder

execute(byte[]) - Method in class org.xfp.filters.codec.CodecBinaryEncoder

execute(String) - Method in class org.xfp.filters.codec.CodecStringDecoder

execute(String) - Method in class org.xfp.filters.codec.CodecStringEncoder

execute(Collection) - Method in class org.xfp.filters.collections.Iterator

Executes this filter.

execute() - Method in class org.xfp.filters.collections.ListGenerator

Executes this filter.

execute() - Method in class org.xfp.filters.collections.MapGenerator

Executes this filter.

execute(Map) - Method in class org.xfp.filters.collections.MapIterator

Executes this filter.

execute(byte[]) - Method in class org.xfp.filters.convert.ByteArrayToInputStream

Executes this filter.

execute(InputStream) - Method in class org.xfp.filters.convert.InputStreamToByteArray

Executes this filter.

execute(InputStream) - Method in class org.xfp.filters.convert.InputStreamToString

Executes this filter.

execute(Reader) - Method in class org.xfp.filters.convert.ReaderToString

Executes this filter.

execute(String) - Method in class org.xfp.filters.convert.StringToInputStream

Executes this filter.

execute(String) - Method in class org.xfp.filters.file.DeleteFile

Executes this filter.

execute(File) - Method in class org.xfp.filters.file.DeleteFile

Executes this filter.

execute() - Method in class org.xfp.filters.file.FileReader

execute(String) - Method in class org.xfp.filters.file.FileReader

execute(File) - Method in class org.xfp.filters.file.FileReader

execute(String) - Method in class org.xfp.filters.file.FileWriter

Executes this filter.

execute(InputStream) - Method in class org.xfp.filters.file.FileWriter

Executes this filter.

execute(byte[]) - Method in class org.xfp.filters.file.FileWriter

Executes this filter.

execute() - Method in class org.xfp.filters.ftp.FTPChangeDirectory

Executes this filter.

execute() - Method in class org.xfp.filters.ftp.FTPChangeToParentDirectory

Executes this filter.

execute(String) - Method in class org.xfp.filters.ftp.FTPDelete

Executes this filter.

execute(FTPFile) - Method in class org.xfp.filters.ftp.FTPDelete

Executes this filter.

execute() - Method in class org.xfp.filters.ftp.FTPDelete

Executes this filter.

execute(String) - Method in class org.xfp.filters.ftp.FTPGet

Executes this filter.

execute() - Method in class org.xfp.filters.ftp.FTPGet

Executes this filter.

execute(FTPFile) - Method in class org.xfp.filters.ftp.FTPGet

Executes this filter.

execute() - Method in class org.xfp.filters.ftp.FTPListing

Executes this filter.

execute() - Method in class org.xfp.filters.ftp.FTPMove

Executes this filter.

execute(String) - Method in class org.xfp.filters.ftp.FTPMove

Executes this filter.

execute(FTPFile) - Method in class org.xfp.filters.ftp.FTPMove

Executes this filter.

execute() - Method in class org.xfp.filters.jndi.JNDIBind

execute() - Method in class org.xfp.filters.jndi.JNDILookup

execute(Object) - Method in class org.xfp.filters.jxpath.JXPathGetValue

Executes this filter.

execute(Object) - Method in class org.xfp.filters.jxpath.JXPathIterate

Executes this filter.

execute(Object) - Method in class org.xfp.filters.jxpath.JXPathSetValue

Executes this filter.

execute(Object) - Method in class org.xfp.filters.util.CheckAlreadyFiltered

Executes this filter.

execute(Object) - Method in class org.xfp.filters.util.PassThru

Executes this filter.

execute(File) - Method in class org.xfp.filters.xml.DOMParser

Executes this filter.

execute(InputSource) - Method in class org.xfp.filters.xml.DOMParser

Executes this filter.

execute(InputStream) - Method in class org.xfp.filters.xml.DOMParser

Executes this filter.

execute(Reader) - Method in class org.xfp.filters.xml.DOMParser

Executes this filter.

execute(String) - Method in class org.xfp.filters.xml.DOMParser

Executes this filter.

execute(URI) - Method in class org.xfp.filters.xml.DOMParser

Executes this filter.

execute(String) - Method in class org.xfp.filters.xml.FOProcessor

Executes this filter.

execute(InputStream) - Method in class org.xfp.filters.xml.FOProcessor

Executes this filter.

execute(Reader) - Method in class org.xfp.filters.xml.FOProcessor

Executes this filter.

execute(InputSource) - Method in class org.xfp.filters.xml.FOProcessor

Executes this filter.

execute(Node) - Method in class org.xfp.filters.xml.XPathNode

Executes this filter.

execute(Node) - Method in class org.xfp.filters.xml.XPathNodeList

Executes this filter.

execute() - Method in class org.xfp.filters.xml.XPathNodeList

Executes this filter.

execute(Node) - Method in class org.xfp.filters.xml.XPathString

Executes this filter.

execute(Node) - Method in class org.xfp.filters.xml.XSLTransformer

Executes this filter.

execute(InputStream) - Method in class org.xfp.filters.xml.XSLTransformer

Executes this filter.

execute(String) - Method in class org.xfp.filters.xml.XSLTransformer

Executes this filter.

F

FOProcessor - class org.xfp.filters.xml.FOProcessor.

Performs an XSL-FO trasformation using Apache FOP.

FOProcessor() - Constructor for class org.xfp.filters.xml.FOProcessor

FTPAbstractFilter - class org.xfp.filters.ftp.FTPAbstractFilter.

Base class for filters performing FTP operations.

FTPAbstractFilter() - Constructor for class org.xfp.filters.ftp.FTPAbstractFilter

FTPChangeDirectory - class org.xfp.filters.ftp.FTPChangeDirectory.

Changes the current working directory on the remote server.

FTPChangeDirectory() - Constructor for class org.xfp.filters.ftp.FTPChangeDirectory

FTPChangeToParentDirectory - class org.xfp.filters.ftp.FTPChangeToParentDirectory.

Changes the current working directory on the remote server to the parent directory.

FTPChangeToParentDirectory() - Constructor for class org.xfp.filters.ftp.FTPChangeToParentDirectory

FTPClientComponent - class org.xfp.components.FTPClientComponent.

FTP client session using Apache Commons Net.

FTPClientComponent() - Constructor for class org.xfp.components.FTPClientComponent

FTPDelete - class org.xfp.filters.ftp.FTPDelete.

Delets a file on an FTP server.

FTPDelete() - Constructor for class org.xfp.filters.ftp.FTPDelete

FTPGet - class org.xfp.filters.ftp.FTPGet.

Downloads a file from an FTP server.

FTPGet() - Constructor for class org.xfp.filters.ftp.FTPGet

FTPListing - class org.xfp.filters.ftp.FTPListing.

Lists files in an FTP directory.

FTPListing() - Constructor for class org.xfp.filters.ftp.FTPListing

FTPMove - class org.xfp.filters.ftp.FTPMove.

Moves a remote file on an FTP server.

FTPMove() - Constructor for class org.xfp.filters.ftp.FTPMove

FileReader - class org.xfp.filters.file.FileReader.

Reads from a file.

FileReader() - Constructor for class org.xfp.filters.file.FileReader

FileWriter - class org.xfp.filters.file.FileWriter.

Writes input data to a File.

FileWriter() - Constructor for class org.xfp.filters.file.FileWriter

Filter - class org.xfp.Filter.

Base class for all filters.

Filter() - Constructor for class org.xfp.Filter

Filter.OnErrorEnum - class org.xfp.Filter.OnErrorEnum.

OnError typesafe enumeration.

Filter.OnLoopErrorEnum - class org.xfp.Filter.OnLoopErrorEnum.

OnLoopError typesafe enumeration.

ftp - Variable in class org.xfp.filters.ftp.FTPAbstractFilter

ftp client

G

getAttributes() - Method in class org.xfp.AttributeContainer

Gets the attributes.

getCalendar() - Method in class org.xfp.engine.TriggerBundle

getEnum(String) - Static method in class org.xfp.Filter.OnErrorEnum

Gets the enum attribute of the OnErrorEnum class

getEnum(String) - Static method in class org.xfp.Filter.OnLoopErrorEnum

Gets the enum attribute of the OnLoopErrorEnum class

getEvaluator(Document) - Static method in class org.xfp.engine.XPathUtils

getFilters() - Method in class org.xfp.Pipeline

Gets the first level filters.

getFullName() - Method in class org.xfp.AttributeContainer

getName() - Method in class org.xfp.AttributeContainer

getName() - Method in class org.xfp.AttributeDefinition

getName() - Method in class org.xfp.engine.PipelineJobListener

getName() - Method in class org.xfp.engine.Task

getNamespaceResolver() - Static method in class org.xfp.engine.XPathUtils

getOnError() - Method in class org.xfp.Filter

Gets the onError attribute of the Filter object.

getParameters() - Method in class org.xfp.AttributeDefinition

getPasswordAuthentication() - Method in class org.xfp.components.SMTPHelper.MailAuthenticator

overrides the getPasswordAuthentication method in the super class

getSession() - Method in class org.xfp.components.SMTPHelper

getTaskJobListener() - Method in class org.xfp.engine.Task

getTrigger() - Method in class org.xfp.engine.TriggerBundle

getTriggerBundles() - Method in class org.xfp.engine.Task

getType() - Method in class org.xfp.AttributeDefinition

getXpath() - Method in class org.xfp.filters.jxpath.JXPathAbstractFilter

Returns the xpath.

H

HTTPGet - class org.xfp.filters.HTTPGet.

Performs an HTTP request.

HTTPGet() - Constructor for class org.xfp.filters.HTTPGet

I

ISO8601DateConverter - class org.xfp.engine.ISO8601DateConverter.

Standard Converter implementation that converts an incoming String into a java.util.Date object according to the ISO 8601 standard, optionally using a default value or throwing a ConversionException if a conversion error occurs.

ISO8601DateConverter() - Constructor for class org.xfp.engine.ISO8601DateConverter

Create a Converter that will throw a ConversionException if a conversion error occurs.

ISO8601DateConverter(Object) - Constructor for class org.xfp.engine.ISO8601DateConverter

Create a Converter that will return the specified default value if a conversion error occurs.

InputStreamToByteArray - class org.xfp.filters.convert.InputStreamToByteArray.

Converts an InputStream to a byte array.

InputStreamToByteArray() - Constructor for class org.xfp.filters.convert.InputStreamToByteArray

InputStreamToString - class org.xfp.filters.convert.InputStreamToString.

Converts an InputStream to a string.

InputStreamToString() - Constructor for class org.xfp.filters.convert.InputStreamToString

Iterator - class org.xfp.filters.collections.Iterator.

Outputs an Iterator for the specified Collection.

Iterator() - Constructor for class org.xfp.filters.collections.Iterator

ifExceptionThrow() - Method in class org.xfp.MultiException

Throw a multiexception.

ifExceptionThrowMulti() - Method in class org.xfp.MultiException

Throw a multiexception.

initialize() - Method in class org.xfp.Filter

Initializes the filter.

initialize() - Method in class org.xfp.components.FTPClientComponent

initialize() - Method in class org.xfp.engine.Engine

Initialize.

initializeAttributes() - Method in class org.xfp.AttributeContainer

Instantiates attributes using attribute definitions.

inputStreamToString(InputStream, String) - Static method in class org.xfp.filters.convert.InputStreamToString

Read the content of a Stream into a String

isRunning() - Method in class org.xfp.Pipeline

Returns true if this pipeline is currently running.

isRunning() - Method in interface org.xfp.engine.TaskJobListener

iterator() - Static method in class org.xfp.Filter.OnErrorEnum

iterator() - Static method in class org.xfp.Filter.OnLoopErrorEnum

J

JNDIAbstractFilter - class org.xfp.filters.jndi.JNDIAbstractFilter.

Base class for filters performing JNDI operations.

JNDIAbstractFilter() - Constructor for class org.xfp.filters.jndi.JNDIAbstractFilter

JNDIBind - class org.xfp.filters.jndi.JNDIBind.

Performs a JNDI lookup.

JNDIBind() - Constructor for class org.xfp.filters.jndi.JNDIBind

JNDILookup - class org.xfp.filters.jndi.JNDILookup.

Performs a JNDI lookup.

JNDILookup() - Constructor for class org.xfp.filters.jndi.JNDILookup

JXPathAbstractFilter - class org.xfp.filters.jxpath.JXPathAbstractFilter.

Base class for filters performing JXPath operations.

JXPathAbstractFilter() - Constructor for class org.xfp.filters.jxpath.JXPathAbstractFilter

JXPathGetValue - class org.xfp.filters.jxpath.JXPathGetValue.

Evaluates the xpath, converts the result to the specified class and returns the resulting object.

JXPathGetValue() - Constructor for class org.xfp.filters.jxpath.JXPathGetValue

JXPathIterate - class org.xfp.filters.jxpath.JXPathIterate.

Evaluates the xpath and returns an Iterator on the results.

JXPathIterate() - Constructor for class org.xfp.filters.jxpath.JXPathIterate

JXPathSetValue - class org.xfp.filters.jxpath.JXPathSetValue.

Modifies the value of the property described by the supplied xpath.

JXPathSetValue() - Constructor for class org.xfp.filters.jxpath.JXPathSetValue

jobToBeExecuted(JobExecutionContext) - Method in class org.xfp.engine.PipelineJobListener

Calls the Pipeline execute() method.

jobWasExecuted(JobExecutionContext, JobExecutionException) - Method in class org.xfp.engine.PipelineJobListener

No op.

L

ListGenerator - class org.xfp.filters.collections.ListGenerator.

Generates a List.

ListGenerator() - Constructor for class org.xfp.filters.collections.ListGenerator

log(String) - Method in class org.xfp.Filter

Subclasses can use this method to log for debugging purposes.

logger - Static variable in class org.xfp.AttributeContainer

logger FIXME how to get the logger from a subclass?

logger - Variable in class org.xfp.Pipeline

M

Main - class org.xfp.engine.Main.

This is the main class for the XFP engine.

MapGenerator - class org.xfp.filters.collections.MapGenerator.

Generates a Map.

MapGenerator() - Constructor for class org.xfp.filters.collections.MapGenerator

MapIterator - class org.xfp.filters.collections.MapIterator.

Outputs an Iterator on the entry set of the specified Map.

MapIterator() - Constructor for class org.xfp.filters.collections.MapIterator

MultiException - exception org.xfp.MultiException.

Wraps multiple exceptions.

MultiException(String) - Constructor for class org.xfp.MultiException

m_password - Variable in class org.xfp.components.SMTPHelper.MailAuthenticator

The users password used for basic authentication

m_user - Variable in class org.xfp.components.SMTPHelper.MailAuthenticator

The users username used for basic authentication

main(String[]) - Static method in class org.xfp.engine.Main

The main program for the Main class

N

name - Variable in class org.xfp.AttributeContainer

attribute container name

newInstance(Node, XPathEvaluator, Class, AttributeContainer, LoggerRepository) - Static method in class org.xfp.Filter

Instantiates and initializes a Filter.

node - Variable in class org.xfp.filters.xml.XPathAbstractFilter

O

org.xfp - package org.xfp

This package contains the XFP framework.

org.xfp.components - package org.xfp.components

This package contains the built-in components.

org.xfp.engine - package org.xfp.engine

This package contains the XFP Engine

org.xfp.filters - package org.xfp.filters

This package and subpackages contain the built-in Filters

org.xfp.filters.beans - package org.xfp.filters.beans

This package contains JavaBeans related Filters.

org.xfp.filters.codec - package org.xfp.filters.codec

This package contains filters related to the Jakarta Commons Codec package.

org.xfp.filters.collections - package org.xfp.filters.collections

This package contains filters related to the Java Collection Framework.

org.xfp.filters.convert - package org.xfp.filters.convert

This package contains type conversion Filters

org.xfp.filters.file - package org.xfp.filters.file

This package contains filters using the local filesystem

org.xfp.filters.ftp - package org.xfp.filters.ftp

This package contains FTP related Filters.

org.xfp.filters.jndi - package org.xfp.filters.jndi

This package contains JNDI related Filters.

org.xfp.filters.jxpath - package org.xfp.filters.jxpath

This package contains Jakarta Commons JXPath related Filters.

org.xfp.filters.util - package org.xfp.filters.util

This package contains utility filters

org.xfp.filters.xml - package org.xfp.filters.xml

This package contains XML related Filters.

P

PassThru - class org.xfp.filters.util.PassThru.

A dummy filter that simply outputs its input.

PassThru() - Constructor for class org.xfp.filters.util.PassThru

PatternMatcher - class org.xfp.filters.PatternMatcher.

Attempts to match the entire input sequence against the pattern.

PatternMatcher() - Constructor for class org.xfp.filters.PatternMatcher

Pipeline - class org.xfp.Pipeline.

A Pipeline contains one or more filter trees.

Pipeline(Document, File, AttributeContainer, LoggerRepository) - Constructor for class org.xfp.Pipeline

Constructor for the Pipeline object.

PipelineJobListener - class org.xfp.engine.PipelineJobListener.

A Quartz JobListener wrapper around Pipeline.

PipelineJobListener(String, File, Document, AttributeContainer, LoggerRepository) - Constructor for class org.xfp.engine.PipelineJobListener

Sole constructor.

PropertyHelper - class org.xfp.PropertyHelper.

Helper class for ${} expressions.

parameterize(Parameters) - Method in class org.xfp.components.FTPClientComponent

parameterize(Parameters) - Method in class org.xfp.components.SMTPHelper

parameterize(Parameters) - Method in class org.xfp.engine.Engine

Parameterize.

parentContainer - Variable in class org.xfp.AttributeContainer

Parent attribute container, if any.

parseXML(InputSource, String) - Static method in class org.xfp.engine.XMLUtils

Parses XML.

parseXMLFile(File, String) - Static method in class org.xfp.engine.XMLUtils

Parses XML files.

parseXMLResource(String, String) - Static method in class org.xfp.engine.XMLUtils

Parses XML resources.

perform(FilterContext, Object) - Method in class org.xfp.Filter

Performing a filter consists of: provide filter attributes set filter properties invoke the 'execute' method call the 'release' method perform children filters release filter attributes Filter developers never call this method!

pipelineSchema - Static variable in class org.xfp.engine.XMLUtils

W3C Schema for Pipeline documents

printStackTrace() - Method in class org.xfp.MultiException

Prints the stack trace of this exception plus all the contained exceptions.

printStackTrace(PrintStream) - Method in class org.xfp.MultiException

printStackTrace(PrintWriter) - Method in class org.xfp.MultiException

R

ReaderToString - class org.xfp.filters.convert.ReaderToString.

Converts an Reader to a string.

ReaderToString() - Constructor for class org.xfp.filters.convert.ReaderToString

readerToString(Reader) - Static method in class org.xfp.filters.convert.ReaderToString

Read the entire content of a Reader into a String

replaceProperties(String, Map) - Static method in class org.xfp.PropertyHelper

Replaces ${xxx} style constructions in the given value with the string value of the corresponding data types.

reset() - Method in class org.xfp.Filter

Resets filter status after execution.

reset() - Method in class org.xfp.filters.AntTask

reset() - Method in class org.xfp.filters.DateGenerator

reset() - Method in class org.xfp.filters.HTTPGet

reset() - Method in class org.xfp.filters.PatternMatcher

reset() - Method in class org.xfp.filters.beans.BeanCollectionSorter

reset() - Method in class org.xfp.filters.beans.BeanInstance

reset() - Method in class org.xfp.filters.beans.BeanXMLDecoder

reset() - Method in class org.xfp.filters.beans.BeanXMLEncoder

reset() - Method in class org.xfp.filters.codec.CodecBinaryDecoder

reset() - Method in class org.xfp.filters.codec.CodecBinaryEncoder

reset() - Method in class org.xfp.filters.codec.CodecStringDecoder

reset() - Method in class org.xfp.filters.codec.CodecStringEncoder

reset() - Method in class org.xfp.filters.collections.Iterator

reset() - Method in class org.xfp.filters.collections.ListGenerator

reset() - Method in class org.xfp.filters.collections.MapGenerator

reset() - Method in class org.xfp.filters.collections.MapIterator

reset() - Method in class org.xfp.filters.convert.ByteArrayToInputStream

reset() - Method in class org.xfp.filters.convert.InputStreamToByteArray

reset() - Method in class org.xfp.filters.convert.InputStreamToString

reset() - Method in class org.xfp.filters.convert.ReaderToString

reset() - Method in class org.xfp.filters.convert.StringToInputStream

reset() - Method in class org.xfp.filters.file.DeleteFile

reset() - Method in class org.xfp.filters.file.FileReader

reset() - Method in class org.xfp.filters.file.FileWriter

reset() - Method in class org.xfp.filters.ftp.FTPAbstractFilter

reset() - Method in class org.xfp.filters.jndi.JNDIAbstractFilter

reset() - Method in class org.xfp.filters.jxpath.JXPathAbstractFilter

reset() - Method in class org.xfp.filters.util.CheckAlreadyFiltered

reset() - Method in class org.xfp.filters.util.PassThru

reset() - Method in class org.xfp.filters.xml.DOMParser

reset() - Method in class org.xfp.filters.xml.FOProcessor

reset() - Method in class org.xfp.filters.xml.XPathAbstractFilter

reset() - Method in class org.xfp.filters.xml.XSLTransformer

S

SMTPHelper - class org.xfp.components.SMTPHelper.

Helper class for SMTP.

SMTPHelper() - Constructor for class org.xfp.components.SMTPHelper

SMTPHelper.MailAuthenticator - class org.xfp.components.SMTPHelper.MailAuthenticator.

Class for SMTP authentication.

SMTPHelper.MailAuthenticator(String, String) - Constructor for class org.xfp.components.SMTPHelper.MailAuthenticator

Constructor calls the super class constructor

SMTPHelper.MailAuthenticator() - Constructor for class org.xfp.components.SMTPHelper.MailAuthenticator

Constructor calls the super class constructor

StringToInputStream - class org.xfp.filters.convert.StringToInputStream.

Converts a String to an InputStream.

StringToInputStream() - Constructor for class org.xfp.filters.convert.StringToInputStream

scheduleSchema - Static variable in class org.xfp.engine.XMLUtils

W3C Schema for Schedule documents

selectBoolean(String, Node, XPathEvaluator) - Static method in class org.xfp.engine.XPathUtils

selectIterator(String, Node, XPathEvaluator) - Static method in class org.xfp.engine.XPathUtils

selectNodeSnapshot(String, Node, XPathEvaluator) - Static method in class org.xfp.engine.XPathUtils

selectNumber(String, Node, XPathEvaluator) - Static method in class org.xfp.engine.XPathUtils

selectSingleNode(String, Node, XPathEvaluator) - Static method in class org.xfp.engine.XPathUtils

selectString(String, Node, XPathEvaluator, boolean) - Static method in class org.xfp.engine.XPathUtils

sendMessage(Message) - Method in class org.xfp.components.SMTPHelper

Sends a message.

setAppend(boolean) - Method in class org.xfp.filters.file.FileWriter

Sets the append write mode.

setAttribute(String, String) - Method in class org.xfp.filters.AntTask

Sets attribute of the ant task.

setAttribute(String, Object) - Method in class org.xfp.filters.xml.DOMParser

Allows the user to set specific attributes on the underlying JAXP implementation.

setClassName(String) - Method in class org.xfp.filters.codec.CodecBinaryDecoder

The class name of the decoder to use.

setClassName(String) - Method in class org.xfp.filters.codec.CodecBinaryEncoder

The class name of the decoder to use.

setClassName(String) - Method in class org.xfp.filters.codec.CodecStringDecoder

The class name of the decoder to use.

setClassName(String) - Method in class org.xfp.filters.codec.CodecStringEncoder

The class name of the encoder to use.

setClient(FTPClient) - Method in class org.xfp.filters.ftp.FTPAbstractFilter

Sets name of the FTPClient attribute.

setCoalescing(boolean) - Method in class org.xfp.filters.xml.DOMParser

Specifies that the parser produced by this code will convert CDATA nodes to Text nodes and append it to the adjacent (if any) text node.

setDirectories(boolean) - Method in class org.xfp.filters.ftp.FTPListing

List directories

setDirectory(String) - Method in class org.xfp.filters.ftp.FTPChangeDirectory

Sets the remote directory

setDirectory(String) - Method in class org.xfp.filters.ftp.FTPListing

Sets the remote directory

setDirectory(String) - Method in class org.xfp.filters.ftp.FTPMove

Sets the remote destination directory.

setEncoding(String) - Method in class org.xfp.filters.convert.InputStreamToString

Sets the encoding attribute of the HTTPGet object

setEncoding(String) - Method in class org.xfp.filters.file.FileWriter

Sets the character encoding.

setEncoding(String) - Method in class org.xfp.filters.xml.XSLTransformer

Sets the character encoding.

setEntry(String, String) - Method in class org.xfp.filters.collections.MapGenerator

Adds an entry to the map.

setEnvironment(String, String) - Method in class org.xfp.filters.jndi.JNDIAbstractFilter

Adds a new environment property to the initial context.

setExpandEntityReferences(boolean) - Method in class org.xfp.filters.xml.DOMParser

Specifies that the parser produced by this code will expand entity reference nodes.

setFilename(String) - Method in class org.xfp.filters.file.FileReader

Sets the name of the file to read from.

setFilename(String) - Method in class org.xfp.filters.file.FileWriter

Sets the name of the file to write to.

setFilename(String) - Method in class org.xfp.filters.ftp.FTPDelete

Sets the filename.

setFilename(String) - Method in class org.xfp.filters.ftp.FTPGet

Sets the name of the file

setFilename(String) - Method in class org.xfp.filters.ftp.FTPMove

Sets the name of the remote file to move.

setFiles(boolean) - Method in class org.xfp.filters.ftp.FTPListing

List files

setFollowRedirects(boolean) - Method in class org.xfp.filters.HTTPGet

Sets whether HTTP redirects (requests with response code 3xx) should be automatically followed.

setFormat(String) - Method in class org.xfp.filters.xml.FOProcessor

Sets the MIME type of the format to generate ex.

setIfModified(boolean) - Method in class org.xfp.filters.HTTPGet

Sets the ifModified.

setIgnoringComments(boolean) - Method in class org.xfp.filters.xml.DOMParser

Specifies that the parser produced by this code will ignore comments.

setIgnoringElementContentWhitespace(boolean) - Method in class org.xfp.filters.xml.DOMParser

Specifies that the parsers created by this factory must eliminate whitespace in element content (sometimes known loosely as 'ignorable whitespace') when parsing XML documents (see XML Rec 2.10).

setItem(String) - Method in class org.xfp.filters.collections.ListGenerator

Adds an item to the list.

setMethod(String) - Method in class org.xfp.filters.HTTPGet

Sets the request method.

setMkdirs(boolean) - Method in class org.xfp.filters.file.FileWriter

If set to true, the filter will create the parent directory of the filename, including any necessary but nonexistent parent directories.

setName(String) - Method in class org.xfp.filters.jndi.JNDIAbstractFilter

Sets the JNDI name of the object for the JNDI operation.

setNamespaceAware(boolean) - Method in class org.xfp.filters.xml.DOMParser

Specifies that the parser produced by this code will provide support for XML namespaces.

setNode(Node) - Method in class org.xfp.filters.xml.XPathAbstractFilter

Sets the context node.

setObject(Object) - Method in class org.xfp.filters.jndi.JNDIBind

Sets the object to bind.

setOption(String, String) - Method in class org.xfp.filters.xml.FOProcessor

Sets a configuration option.

setOverwrite(boolean) - Method in class org.xfp.filters.file.FileWriter

Sets the wheter to overwrite an existing file.

setPDFOption(String, String) - Method in class org.xfp.filters.xml.FOProcessor

Sets a configuration option.

setParameter(String, String) - Method in class org.xfp.filters.xml.XSLTransformer

Sets an XSL parameter to be used together with the xsl:param tag.

setPassword(String) - Method in class org.xfp.filters.HTTPGet

Sets the password for the basic authentication.

setPattern(String) - Method in class org.xfp.filters.DateGenerator

Sets the pattern attribute of the DateGenerator object.

setPattern(String) - Method in class org.xfp.filters.PatternMatcher

Sets the pattern.

setProperties(Object, Node, XPathEvaluator) - Static method in class org.xfp.PropertyHelper

setProperty(String) - Method in class org.xfp.filters.beans.BeanCollectionSorter

Sets the bean property used to sort the Collection.

setProperty(String, Object) - Method in class org.xfp.filters.beans.BeanInstance

Sets a bean property.

setRecurse(boolean) - Method in class org.xfp.filters.ftp.FTPListing

Recurse in subdirectories

setRequiredType(Class) - Method in class org.xfp.filters.jxpath.JXPathGetValue

Sets the required type.

setReverse(boolean) - Method in class org.xfp.filters.beans.BeanCollectionSorter

If true, imposes the reverse of the natural ordering.

setSort(String) - Method in class org.xfp.filters.ftp.FTPListing

Sets the sort.

setSortAscendant(boolean) - Method in class org.xfp.filters.ftp.FTPListing

Sets the sortAscendant.

setStylesheet(String) - Method in class org.xfp.filters.xml.XSLTransformer

Sets the stylesheet to use.

setSymbolicLinks(boolean) - Method in class org.xfp.filters.ftp.FTPListing

List symbolic links

setTask(String) - Method in class org.xfp.filters.AntTask

Sets the task type.

setText(String) - Method in class org.xfp.filters.AntTask

Sets the text.

setType(String) - Method in class org.xfp.filters.beans.BeanInstance

Sets the type.

setUrl(String) - Method in class org.xfp.filters.HTTPGet

Sets the URL to get.

setUseragent(String) - Method in class org.xfp.filters.HTTPGet

Sets the User-Agent request header.

setUsername(String) - Method in class org.xfp.filters.HTTPGet

Sets the username for the basic authentication.

setValidating(boolean) - Method in class org.xfp.filters.xml.DOMParser

Specifies that the parser produced by this code will validate documents as they are parsed.

setValue(Object) - Method in class org.xfp.filters.jxpath.JXPathSetValue

Sets the value.

setXpath(String) - Method in class org.xfp.filters.jxpath.JXPathAbstractFilter

Sets the xpath.

setXpath(String) - Method in class org.xfp.filters.xml.XPathAbstractFilter

Sets the XPath query.

size() - Method in class org.xfp.MultiException

start() - Method in class org.xfp.engine.Engine

Start.

stop() - Method in class org.xfp.engine.Engine

Stop.

subreset() - Method in class org.xfp.filters.ftp.FTPAbstractFilter

Subclasses must reset their status within this method.

subreset() - Method in class org.xfp.filters.ftp.FTPChangeDirectory

subreset() - Method in class org.xfp.filters.ftp.FTPChangeToParentDirectory

subreset() - Method in class org.xfp.filters.ftp.FTPDelete

subreset() - Method in class org.xfp.filters.ftp.FTPGet

subreset() - Method in class org.xfp.filters.ftp.FTPListing

subreset() - Method in class org.xfp.filters.ftp.FTPMove

subreset() - Method in class org.xfp.filters.jndi.JNDIAbstractFilter

Subclasses must reset their status within this method.

subreset() - Method in class org.xfp.filters.jndi.JNDIBind

subreset() - Method in class org.xfp.filters.jndi.JNDILookup

subreset() - Method in class org.xfp.filters.jxpath.JXPathAbstractFilter

Subclasses must reset their status within this method.

subreset() - Method in class org.xfp.filters.jxpath.JXPathGetValue

subreset() - Method in class org.xfp.filters.jxpath.JXPathIterate

subreset() - Method in class org.xfp.filters.jxpath.JXPathSetValue

subreset() - Method in class org.xfp.filters.xml.XPathAbstractFilter

Subclasses must reset their status within this method.

subreset() - Method in class org.xfp.filters.xml.XPathNode

subreset() - Method in class org.xfp.filters.xml.XPathNodeList

subreset() - Method in class org.xfp.filters.xml.XPathString

T

Task - class org.xfp.engine.Task.

A Task contains information about three different aspects of a procedure: logic, scheduling and logging.

Task(File, AttributeContainer) - Constructor for class org.xfp.engine.Task

Sole constructor.

TaskJobListener - interface org.xfp.engine.TaskJobListener.

Interface for the Task 'logic' aspect.

TriggerBundle - class org.xfp.engine.TriggerBundle.

Contains a Trigger and its associated Calendar, if any.

toString() - Method in class org.xfp.Filter

toString() - Method in class org.xfp.Pipeline

toString() - Method in class org.xfp.components.SMTPHelper

toString.

V

VERSION - Static variable in class org.xfp.XFP

Application version.

X

XFP - class org.xfp.XFP.

XFP class.

XMLUtils - class org.xfp.engine.XMLUtils.

XML parsing utilities.

XMLUtils() - Constructor for class org.xfp.engine.XMLUtils

XPathAbstractFilter - class org.xfp.filters.xml.XPathAbstractFilter.

Base class for filters performing XPath operations.

XPathAbstractFilter() - Constructor for class org.xfp.filters.xml.XPathAbstractFilter

XPathNode - class org.xfp.filters.xml.XPathNode.

Performs an XPath query and outputs a Node.

XPathNode() - Constructor for class org.xfp.filters.xml.XPathNode

XPathNodeList - class org.xfp.filters.xml.XPathNodeList.

Performs an XPath query and outputs a List of nodes.

XPathNodeList() - Constructor for class org.xfp.filters.xml.XPathNodeList

XPathString - class org.xfp.filters.xml.XPathString.

Performs an XPath query and outputs a String.

XPathString() - Constructor for class org.xfp.filters.xml.XPathString

XPathUtils - class org.xfp.engine.XPathUtils.

Utility methods for the DOM Level 3 XPath API.

XPathUtils() - Constructor for class org.xfp.engine.XPathUtils

XSLTransformer - class org.xfp.filters.xml.XSLTransformer.

Performs an XSL Transformation.

XSLTransformer() - Constructor for class org.xfp.filters.xml.XSLTransformer

xpath - Variable in class org.xfp.filters.xml.XPathAbstractFilter

xpathapi - Variable in class org.xfp.filters.xml.XPathAbstractFilter

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