A B C D E F G I M N O P R S T U W X

A

ACTION_ADD - Static variable in class org.apache.torque.betwixt.XMLEventNotifier

Tag for record added (Inserted) notifications

ACTION_DELETE - Static variable in class org.apache.torque.betwixt.XMLEventNotifier

Tag for record delete notifications

ACTION_ERROR - Static variable in class org.apache.torque.betwixt.XMLEventNotifier

Tag for error notifications

ACTION_INFO - Static variable in class org.apache.torque.betwixt.XMLEventNotifier

Tag for general Info notifications

ACTION_TYPE - Static variable in class org.apache.torque.betwixt.XMLEventNotifier

Tag for record type notifications

ACTION_UPDATE - Static variable in class org.apache.torque.betwixt.XMLEventNotifier

Tag for record update notifications

actionPerformed(int, String, String) - Method in class org.apache.torque.betwixt.util.ImportSummaryListener

actionPerformed(int, String, String) - Method in class org.apache.torque.betwixt.util.SimpleListener

actionPerformed(int, String, String) - Method in interface org.apache.torque.betwixt.XMLEventListener

Called when various actions occure in the Exporter and (eventually) Importer classes.

ADD_ONLY - Static variable in class org.apache.torque.betwixt.Importer

Only add records action flag value

ADD_UPDATE - Static variable in class org.apache.torque.betwixt.Importer

Add or update record action flag value

addRecord(Object) - Method in class org.apache.torque.betwixt.Dataset

Add an individual item to the data set.

addRecord(BaseObject, Importer) - Method in class org.apache.torque.betwixt.util.BaseObjectRecordHandler

Add a new record from imported information.

addRecordList(List) - Method in class org.apache.torque.betwixt.Dataset

Add a list or records to the end of the current collection.

addUpdateRecord(Object, Importer) - Method in interface org.apache.torque.betwixt.RecordHandler

Handles both creating new record or updating existing record.

addUpdateRecord(Object, Importer) - Method in class org.apache.torque.betwixt.util.BaseObjectRecordHandler

B

BaseObjectRecordHandler - Class in org.apache.torque.betwixt.util

This is a generic RecordHandler implimentation for Torque objects.

BaseObjectRecordHandler() - Constructor for class org.apache.torque.betwixt.util.BaseObjectRecordHandler

Generic constructor

C

clone() - Method in interface org.apache.torque.betwixt.RecordHandler

RecordHandlers need to be cloneable so the dispatcher can clone handlers as needed.

clone() - Method in class org.apache.torque.betwixt.util.BaseObjectRecordHandler

createBeanReader(Resolver) - Method in class org.apache.torque.betwixt.Importer

Create a Betwixt BeanReader to parse XML with.

createBeanWriter(Writer, Resolver) - Method in class org.apache.torque.betwixt.Exporter

Create the BeanWriter object to use to write data out.

D

Dataset - Class in org.apache.torque.betwixt

A container Bean class for records to be exported or imported.

Dataset() - Constructor for class org.apache.torque.betwixt.Dataset

Generic bean constructor

DEFAULT_EVENT - Static variable in class org.apache.torque.betwixt.util.SimpleListener

Key for the default event format in the eventFormats map

DEFAULT_MSG_FORMAT - Static variable in class org.apache.torque.betwixt.util.SimpleListener

Default format if no action event mapping found

DEFAULT_SUMMARY_FORMAT - Static variable in class org.apache.torque.betwixt.util.ImportSummaryListener

Default format if not summaryFormat has been set

DELETE - Static variable in class org.apache.torque.betwixt.Importer

Delete records action flag value

deleteRecord(Object, Importer) - Method in interface org.apache.torque.betwixt.RecordHandler

Handles deleting records.

deleteRecord(Object, Importer) - Method in class org.apache.torque.betwixt.util.BaseObjectRecordHandler

DELETES - Static variable in class org.apache.torque.betwixt.util.ImportSummaryListener

deregisterListener(XMLEventListener) - Method in class org.apache.torque.betwixt.Importer

Remove a listener.

deregisterListener(XMLEventListener) - Method in class org.apache.torque.betwixt.XMLEventNotifier

Remove a listener.

E

error(SAXParseException) - Method in class org.apache.torque.betwixt.Importer

ERRORS - Static variable in class org.apache.torque.betwixt.util.ImportSummaryListener

EXPORT_END - Static variable in class org.apache.torque.betwixt.XMLEventNotifier

Tag for general Export End notifications

EXPORT_RECORD - Static variable in class org.apache.torque.betwixt.XMLEventNotifier

Tag for general Export Record notifications

EXPORT_START - Static variable in class org.apache.torque.betwixt.XMLEventNotifier

Tag for general Export Start notifications

exportData(Dataset, Writer, Resolver) - Method in class org.apache.torque.betwixt.Exporter

Write the records in a dataset to XML

Exporter - Class in org.apache.torque.betwixt

Support for converting Torque (and other Betwixted mapped objects) in a Dataset object into XML format.

Exporter() - Constructor for class org.apache.torque.betwixt.Exporter

F

fatalError(SAXParseException) - Method in class org.apache.torque.betwixt.Importer

findRecordHandler(Object) - Method in class org.apache.torque.betwixt.Importer

Search the registered record handlers for one that matches the class or superclass of the supplied record.

G

getAction() - Method in class org.apache.torque.betwixt.Dataset

Get the value of the action attribute.

getAction() - Method in class org.apache.torque.betwixt.Importer

getBeanWriter() - Method in class org.apache.torque.betwixt.Dataset

Get the bean writer.

getBewtixtFileName() - Method in class org.apache.torque.betwixt.Resolver

Gets the correctly qualified Betwixt mapping file name to try to open via a resource lookup.

getConnection() - Method in class org.apache.torque.betwixt.Importer

Get the connection to save information with.

getCountByType() - Method in class org.apache.torque.betwixt.util.ImportSummaryListener

Gets a hash table with record types as keys and a int[3] array as the value.

getCounts(String) - Method in class org.apache.torque.betwixt.util.ImportSummaryListener

getDatasetRecordNumber() - Method in class org.apache.torque.betwixt.Importer

Get the (1 based) number of the current record object being processed.

getDescription() - Method in class org.apache.torque.betwixt.Dataset

Get the value of the description attribute.

getDtdFileName() - Method in class org.apache.torque.betwixt.Resolver

Get the file name of the DTD that that will be used to validate the XML import with.

getDtdPackage() - Method in class org.apache.torque.betwixt.Resolver

Get the package directory the DTD will be located in.

getDtdUri() - Method in class org.apache.torque.betwixt.Resolver

Gets the URI to locate the DTD via the Internet (if any)

getEventFormat(String) - Method in class org.apache.torque.betwixt.util.SimpleListener

Gets the format to use in writing the specified event.

getEventFormats() - Method in class org.apache.torque.betwixt.util.SimpleListener

Get the eventFormats Map.

getExistingRecord(BaseObject, Importer) - Method in class org.apache.torque.betwixt.util.BaseObjectRecordHandler

Tries to find an existing record in the DB based on the primaryKey of imported record object.

getHandlers() - Method in class org.apache.torque.betwixt.Importer

Get the record handlers hash table.

getListeners() - Method in class org.apache.torque.betwixt.Importer

Gets the registered listeners.

getListeners() - Method in class org.apache.torque.betwixt.XMLEventNotifier

Gets the registered listeners.

getMapFileName() - Method in class org.apache.torque.betwixt.Resolver

Get the name of the Betwixt multi (bean) mapping file to be used.

getMapFilePackage() - Method in class org.apache.torque.betwixt.Resolver

Get the package directory the Betwixt mapping file will be located in.

getName() - Method in class org.apache.torque.betwixt.Dataset

Get the value of the name attribute

getOnError() - Method in class org.apache.torque.betwixt.Dataset

Gets the value of the onError attribute.

getOnError() - Method in class org.apache.torque.betwixt.Importer

getOut() - Method in class org.apache.torque.betwixt.util.SimpleListener

The writer to output messages to.

getRecord() - Method in class org.apache.torque.betwixt.Dataset

Get the record set list.

getSummaryFormat() - Method in class org.apache.torque.betwixt.util.ImportSummaryListener

getType() - Method in class org.apache.torque.betwixt.util.ImportSummaryListener

Gets the last object type specified in an ACTION_TYPE event.

I

IMPORT_END - Static variable in class org.apache.torque.betwixt.XMLEventNotifier

Tag for import end notifications

IMPORT_START - Static variable in class org.apache.torque.betwixt.XMLEventNotifier

Tag for import start notifications

importData(Reader, Resolver) - Method in class org.apache.torque.betwixt.Importer

Create a BeanReader; parse the supplied XML input stream into a Dataset; and then process the Dataset.

Importer - Class in org.apache.torque.betwixt

Top level controller for importing XML into Torque OM objects and storing them into the database.

Importer() - Constructor for class org.apache.torque.betwixt.Importer

Handles parsing XML records into a Dataset object and then dispatching them to the correct record handlers to be processed.

ImportSummaryListener - Class in org.apache.torque.betwixt.util

An XMLEventListener implimentation for writing out import events and creating a summary report of the import actions.

ImportSummaryListener(Writer) - Constructor for class org.apache.torque.betwixt.util.ImportSummaryListener

Construct a new object with the specified Writer as the output destination.

initHandlers() - Method in class org.apache.torque.betwixt.Importer

Initialize the default set of record handlers when class is created.

initialize(Writer) - Method in class org.apache.torque.betwixt.util.ImportSummaryListener

Initialize the class defaults

initialize(Writer) - Method in class org.apache.torque.betwixt.util.SimpleListener

Initialize the class defaults

initOptions(Dataset) - Method in class org.apache.torque.betwixt.Importer

Parses the text version of the Dataset action and onError attributes into option flag values.

INSERTS - Static variable in class org.apache.torque.betwixt.util.ImportSummaryListener

isCounterSet() - Method in class org.apache.torque.betwixt.util.ImportSummaryListener

isErrorParsing() - Method in class org.apache.torque.betwixt.Importer

iterator() - Method in class org.apache.torque.betwixt.Dataset

Get an iterator for this data record set.

M

makeInputSource(String) - Method in class org.apache.torque.betwixt.Resolver

Try to find the specified resource on the classpath.

N

notifyListeners(int, String, String) - Method in class org.apache.torque.betwixt.Importer

Calls all registered listeners to let them know an action occured.

notifyListeners(int, String, String) - Method in class org.apache.torque.betwixt.XMLEventNotifier

Calls all registered listeners to let them know an action occured.

O

ON_ERROR_CONTINUE - Static variable in class org.apache.torque.betwixt.Importer

Continue on error flag value

ON_ERROR_ROLLBACK - Static variable in class org.apache.torque.betwixt.Importer

Roll back on error flag value

ON_ERROR_STOP - Static variable in class org.apache.torque.betwixt.Importer

Stop importing on error flag value

org.apache.torque.betwixt - package org.apache.torque.betwixt

org.apache.torque.betwixt.util - package org.apache.torque.betwixt.util

P

parseXML(Reader, BeanReader) - Method in class org.apache.torque.betwixt.Importer

Populate a Dataset object from the supplied XML input stream.

printSummary(String, String) - Method in class org.apache.torque.betwixt.util.ImportSummaryListener

Outputs summaries for all types imported with the supplied header and footer.

printTypeSummary(String) - Method in class org.apache.torque.betwixt.util.ImportSummaryListener

Outputs a summary for the specified type using the summaryFormat property.

processDataset(Dataset) - Method in class org.apache.torque.betwixt.Importer

The main driver for importing data into a Torque managed database from XML.

R

RecordHandler - Interface in org.apache.torque.betwixt

Interface that all record handlers called by the Importer class should impliment.

registerHandler(Class, RecordHandler) - Method in class org.apache.torque.betwixt.Importer

Register or modify a recordHandler to be used with the specifed class or subclass.

registerListener(XMLEventListener) - Method in class org.apache.torque.betwixt.Importer

Register a listener that will be notified of export actions.

registerListener(XMLEventListener) - Method in class org.apache.torque.betwixt.XMLEventNotifier

Register a listener that will be notified of export actions.

resolveBetwixtFile() - Method in class org.apache.torque.betwixt.Resolver

Locate the required Betwixt map file on the classpath.

resolveDtdUri() - Method in class org.apache.torque.betwixt.Resolver

Resolve the DTD file's URI to use in DOCTYPE elements in the following manner:

resolveEntity(String, String) - Method in class org.apache.torque.betwixt.Resolver

Return an InputSource that provides access to the indicated entity.

Resolver - Class in org.apache.torque.betwixt

This class resolves the where to find the versions of the Betwixt Bean Map and DTD files to use in converting XML data to Torque OM objects.

Resolver() - Constructor for class org.apache.torque.betwixt.Resolver

A resolver to get the inputSource that a SAX parser will use for an import DTD definition.

Resolver(String) - Constructor for class org.apache.torque.betwixt.Resolver

rollbackTransaction() - Method in class org.apache.torque.betwixt.Importer

Attempt to roll back all changes made prior to an error occuring.

S

setAction(String) - Method in class org.apache.torque.betwixt.Dataset

Sets the value of the action attribute

setAction(int) - Method in class org.apache.torque.betwixt.Importer

setConnection(Connection) - Method in class org.apache.torque.betwixt.Importer

Set the database connection to use.

setCounterSet(boolean) - Method in class org.apache.torque.betwixt.util.ImportSummaryListener

setDatasetRecordNumber(int) - Method in class org.apache.torque.betwixt.Importer

Sets the (1 based) number of the current record object being processed.

setDefaultEventFormat(String) - Method in class org.apache.torque.betwixt.util.SimpleListener

A convienence method to set the format used if a format matching the event to be output can not be found.

setDescription(String) - Method in class org.apache.torque.betwixt.Dataset

Set the value of the description attribute.

setDtdFileName(String) - Method in class org.apache.torque.betwixt.Resolver

Set the file name (no path ) of the DTD file to validate the XML against.

setDtdPackage(String) - Method in class org.apache.torque.betwixt.Resolver

Set the package directory the DTD will be located in.

setDtdUri(String) - Method in class org.apache.torque.betwixt.Resolver

Sets the URI to locate the DTD via the Internet (if any).

setErrorParsing(boolean) - Method in class org.apache.torque.betwixt.Importer

setEventFormat(String, String) - Method in class org.apache.torque.betwixt.util.SimpleListener

Sets the format to use in writing information about this particular event.

setHandlers(Hashtable) - Method in class org.apache.torque.betwixt.Importer

Set a new record handler hash table.

setMapFileName(String) - Method in class org.apache.torque.betwixt.Resolver

Set the name of the Betwixt multi (bean) mapping file to be used.

setMapFilePackage(String) - Method in class org.apache.torque.betwixt.Resolver

Set the package directory the Betwixt mapping file will be located in.

setName(String) - Method in class org.apache.torque.betwixt.Dataset

Set the value of the name attribute

setOnError(String) - Method in class org.apache.torque.betwixt.Dataset

Set the value of the onError attribute.

setOnError(int) - Method in class org.apache.torque.betwixt.Importer

setOut(Writer) - Method in class org.apache.torque.betwixt.util.SimpleListener

The writer to output message to.

setRecord(List) - Method in class org.apache.torque.betwixt.Dataset

Replace the record set with the supplied set.

setSummaryFormat(String) - Method in class org.apache.torque.betwixt.util.ImportSummaryListener

setType(String) - Method in class org.apache.torque.betwixt.util.ImportSummaryListener

Sets the last object type identified in an ACTION_TYPE event.

simpleClassName(Class) - Method in class org.apache.torque.betwixt.Importer

Get the name of a class without it's package.

SimpleListener - Class in org.apache.torque.betwixt.util

An implimentation of XMLEventListener that allows for different action type messages to be formatted differently or not displayed.

SimpleListener(Writer) - Constructor for class org.apache.torque.betwixt.util.SimpleListener

size() - Method in class org.apache.torque.betwixt.Dataset

Get the size of the current data set.

startTransaction(Object) - Method in class org.apache.torque.betwixt.Importer

Start a transaction grouping.

suppressAttribute(AttributeDescriptor, String) - Method in class org.apache.torque.betwixt.util.SuppressPrimaryKeys

Do nothing but call DEFAULT implimentation because superclass defines this as abstract.

suppressElement(ElementDescriptor, String, String, String, Object) - Method in class org.apache.torque.betwixt.util.SuppressPrimaryKeys

SuppressPrimaryKeys - Class in org.apache.torque.betwixt.util

A Betwixt BeanWriter ValueSuppressionStategy that will filter out all primary key columns when the XML is written.

SuppressPrimaryKeys() - Constructor for class org.apache.torque.betwixt.util.SuppressPrimaryKeys

T

toString() - Method in class org.apache.torque.betwixt.Dataset

Dump debug info.

U

UPDATE_ONLY - Static variable in class org.apache.torque.betwixt.Importer

Only update records action flag value

updateRecord(BaseObject, BaseObject, Importer) - Method in class org.apache.torque.betwixt.util.BaseObjectRecordHandler

Update an existing record from imported information

UPDATES - Static variable in class org.apache.torque.betwixt.util.ImportSummaryListener

W

warning(SAXParseException) - Method in class org.apache.torque.betwixt.Importer

writeData(Dataset, BeanWriter) - Method in class org.apache.torque.betwixt.Exporter

Write the records in this dataset to XML

writeHeaderInfo(BeanWriter, Resolver) - Method in class org.apache.torque.betwixt.Exporter

Calls the full writeHeaderInfo method with "dataset" as the default element and uses the resolver information to create a SYSTEM Doctype heading.

writeHeaderInfo(BeanWriter, Resolver, String, boolean, String, String) - Method in class org.apache.torque.betwixt.Exporter

Writes the standard xml version processing info and a custom DOCTYPE header to the XML output file.

X

XMLEventListener - Interface in org.apache.torque.betwixt

A simple interface to allow for user / other watcher updates during long export / imports.

XMLEventNotifier - Class in org.apache.torque.betwixt

A Base class with methods that manage event notifications.

XMLEventNotifier() - Constructor for class org.apache.torque.betwixt.XMLEventNotifier

A B C D E F G I M N O P R S T U W X