org.enableit.db.darrt.ant
Class SchemaExporterTask

java.lang.Object
  |
  +--org.apache.tools.ant.ProjectComponent
        |
        +--org.apache.tools.ant.Task
              |
              +--org.enableit.db.ant.AbstractDBTask
                    |
                    +--org.enableit.db.darrt.ant.AbstractSchemaTask
                          |
                          +--org.enableit.db.darrt.ant.SchemaExporterTask

public class SchemaExporterTask

extends AbstractSchemaTask

Ant Task to export a database schema as an XML file.

ASA interpretation of DatabaseMetaData object SCHEMAS = userids and groups

Version:

__VERSION__

Author:

__AUTHOR__

Field Summary

protected static org.apache.log4j.Category	logger The Log4J Category doing the logging.
static int	OM_FILE_PER_TABLE A valid output mode.
static int	OM_SINGLE_FILE A valid output mode.
static int	OM_SINGLE_FILE_AND_FILE_PER_TABLE A valid output mode.

Fields inherited from class org.enableit.db.darrt.ant.AbstractSchemaTask

ABOUT, refFile, refProvider, targetDriver, targetFile, targetPassword, targetProvider, targetSchemaName, targetUrl, targetUserid

Fields inherited from class org.enableit.db.ant.AbstractDBTask

driver, password, schemaName, url, userid

Fields inherited from class org.apache.tools.ant.Task

description, location, target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Constructor Summary

SchemaExporterTask()
Default Constructor

Method Summary

void	execute() Run the schema export.
void	setCatalog(java.lang.String catalog) Set the JDBC catalogue name (Sybase and Microsoft userids are more likely to know this as database name)
void	setDebug(boolean debug) Set the debug flag.
void	setOutput(java.lang.String output) Deprecated. The outputDir and outputFile attributes give better control.
void	setOutputDir(java.lang.String outputDir) Sets the target (output) directory.
void	setOutputFile(java.lang.String outputFile) Sets the target (output) file.
void	setOutputMode(int mode) Sets the output type.
void	setSchema(java.lang.String schema) Set the schema name.
void	setTableNamePattern(java.lang.String tableNamePattern) Set the table name pattern.
void	setTableTypes(java.lang.String tableTypes) Set the table types to export.

Methods inherited from class org.enableit.db.darrt.ant.AbstractSchemaTask

addFormatter, checkInputs, checkRefInputs, checkTargetInputs, getFormatters, getReferenceProvider, getReportListeners, getSchemaHandler, getTargetProvider, setReferenceFile, setSchemaName, setTargetDriver, setTargetFile, setTargetPassword, setTargetUrl, setTargetUserid

Methods inherited from class org.enableit.db.ant.AbstractDBTask

setDriver, setPassword, setUrl, setUserid

Methods inherited from class org.apache.tools.ant.Task

getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, handleErrorOutput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, setProject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

protected static org.apache.log4j.Category logger

The Log4J Category doing the logging. Same Category is used throughout the package.

OM_SINGLE_FILE

public static final int OM_SINGLE_FILE

A valid output mode.

See Also:

Constant Field Values

OM_FILE_PER_TABLE

public static final int OM_FILE_PER_TABLE

A valid output mode.

See Also:

Constant Field Values

OM_SINGLE_FILE_AND_FILE_PER_TABLE

public static final int OM_SINGLE_FILE_AND_FILE_PER_TABLE

A valid output mode.

See Also:

Constant Field Values

Constructor Detail

SchemaExporterTask

public SchemaExporterTask()

Default Constructor

Method Detail

setOutput

public void setOutput(java.lang.String output)

Deprecated. The outputDir and outputFile attributes give better control.

Sets the target (output) directory & file in one

setOutputFile

public void setOutputFile(java.lang.String outputFile)

Sets the target (output) file.

setOutputDir

public void setOutputDir(java.lang.String outputDir)

Sets the target (output) directory.

setTableNamePattern

public void setTableNamePattern(java.lang.String tableNamePattern)

Set the table name pattern.

setSchema

public void setSchema(java.lang.String schema)

Set the schema name.

setTableTypes

public void setTableTypes(java.lang.String tableTypes)

Set the table types to export.

setCatalog

public void setCatalog(java.lang.String catalog)

Set the JDBC catalogue name (Sybase and Microsoft userids are more likely to know this as database name)

setOutputMode

public void setOutputMode(int mode)

Sets the output type.

See Also:

#

execute

public void execute()

Run the schema export.

Specified by:

execute in class AbstractSchemaTask

setDebug

public void setDebug(boolean debug)

Set the debug flag.