net.sourceforge.jdbcexporter
Class ExportEntityDef

java.lang.Object
  net.sourceforge.jdbcimporter.EntityDef
      net.sourceforge.jdbcexporter.ExportEntityDef

public class ExportEntityDef

extends EntityDef

The ExportEntityDef class defines an entity (table) to be exported. This definition includes:

• the name of table (along with the catalog and schema it belongs to)
• the delimiter formatter to use when writing the data to the file
• the file that will contain the exported data
• the columns in the table that will be exported
• the where SQL clause that restricts the data exported (optional)

Version:

0.6

Author:

Chris Nagy

Field Summary

Fields inherited from class net.sourceforge.jdbcimporter.EntityDef

columns

Constructor Summary

ExportEntityDef()

Method Summary

ExportColumnDef[]	getColumns() Returns the list of columns that will be exported.
DelimiterFormatter	getDelimiterFormatter() Returns the delimiter formatter used by the engine.
ExportEngine	getExportEngine() Returns the export engine to use when exporting data for this entity.
java.io.File	getTarget() Returns the file to write the export data to.
java.lang.String	getTargetEncoding() Returns the target file's encoding (may be null).
java.lang.String	getWhereClause() Returns the SQL where clause that will restrict the data exported.
void	setDelimiterFormatter(DelimiterFormatter formatter) Set the delimiter formatter.
void	setExportEngine(ExportEngine engine) Sets the export engine to use when exporting data for this entity.
void	setTarget(java.io.File file) Set the target file.
void	setTargetEncoding(java.lang.String newTargetEncoding) Set the target file's encoding.
void	setWhereClause(java.lang.String string) Set the where clause.
java.lang.String	toString() Overrides Object.toString()

Methods inherited from class net.sourceforge.jdbcimporter.EntityDef

addColumn, addProperty, getCatalog, getColumnCount, getColumnIterator, getProperty, getSchema, getTable, setCatalog, setSchema, setTable

Methods inherited from class java.lang.Object

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

Constructor Detail

ExportEntityDef

public ExportEntityDef()

Method Detail

getDelimiterFormatter

public DelimiterFormatter getDelimiterFormatter()

Returns the delimiter formatter used by the engine.

Returns:

delimiter formatter

getTarget

public java.io.File getTarget()

Returns the file to write the export data to.

Returns:

target file

getTargetEncoding

public java.lang.String getTargetEncoding()

Returns the target file's encoding (may be null).

Returns:

target file's encoding charset

Since:

0.71

getWhereClause

public java.lang.String getWhereClause()

Returns the SQL where clause that will restrict the data exported.

Returns:

where clause

setDelimiterFormatter

public void setDelimiterFormatter(DelimiterFormatter formatter)

Set the delimiter formatter.

Parameters:

formatter - delimiter formatter

setTarget

public void setTarget(java.io.File file)

Set the target file.

Parameters:

file - target file

setTargetEncoding

public void setTargetEncoding(java.lang.String newTargetEncoding)

Set the target file's encoding.

Parameters:

newTargetEncoding - target file's encoding charset

Since:

0.71

setWhereClause

public void setWhereClause(java.lang.String string)

Set the where clause.

Parameters:

string - where clause

setExportEngine

public void setExportEngine(ExportEngine engine)

Sets the export engine to use when exporting data for this entity.

Parameters:

engine - the export engine

Since:

0.67

getExportEngine

public ExportEngine getExportEngine()

Returns the export engine to use when exporting data for this entity.

Returns:

the export engine

Since:

0.67

getColumns

public ExportColumnDef[] getColumns()

Returns the list of columns that will be exported.

Returns:

list of column definitions

toString

public java.lang.String toString()

Overrides Object.toString()