net.sf.jailer.datamodel

Class Table

java.lang.Object

net.sf.jailer.datamodel.ModelElement

net.sf.jailer.datamodel.Table

All Implemented Interfaces:

java.lang.Comparable<Table>

public class Table
extends ModelElement
implements java.lang.Comparable<Table>

Describes a database-table.

Author:

Ralf Wisser

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<Association>	associations Associations to other tables.
boolean	defaultExcludeFromDeletion Data Model default for Exclude from Deletion.
boolean	defaultUpsert Data model default for export mode.
java.lang.Boolean	excludeFromDeletion Exclude from Deletion?
PrimaryKey	primaryKey The primary-key of the table.
java.lang.Boolean	upsert Use upsert (merge) or insert-statement for entities of this table in export-script.

Constructor Summary

Constructors

Constructor and Description
Table(java.lang.String name, PrimaryKey primaryKey, boolean defaultUpsert, boolean defaultExcludeFromDeletion) Constructor.

Method Summary

Modifier and Type	Method and Description
static void	clearSessionProperties(Session session)
java.util.Set<Table>	closure() Gets the closure of the table.
java.util.Set<Table>	closure(java.util.Set<Table> tablesToIgnore) Gets the closure of the table.
java.util.Set<Table>	closure(java.util.Set<Table> tablesToIgnore, java.util.Map<Table,java.lang.Integer> distances) Gets the closure of the table.
int	compareTo(Table o)
boolean	equals(java.lang.Object other) Compares tables.
java.util.List<Column>	getColumns() Gets columns.
org.w3c.dom.Document	getDefaultXmlTemplate(Quoting quoting) Gets default template for XML exports as DOM.
java.lang.String	getName() Gets the table name.
java.util.List<Column>	getNonVirtualPKColumns(Session session) Gets non-virtual and non-filtered primary-key columns.
int	getOrdinal() Gets unique number of this table to be used as type discriminator in JAILER_ENTITY table.
java.lang.String	getOriginalName() Gets the original table-name.
java.lang.String	getOriginalSchema(java.lang.String defaultSchema) Gets un-mapped schema name of table.
java.lang.String	getSchema(java.lang.String defaultSchema) Gets mapped schema name of table.
java.util.List<Column>	getSelectionClause() Gets all non-virtual columns of the table in the order in which they are selected.
java.lang.String	getUnqualifiedName() Gets unqualified name of table.
java.lang.Boolean	getUpsert() Gets export modus.
java.lang.String	getXmlTemplate() Gets template for XML exports.
org.w3c.dom.Document	getXmlTemplateAsDocument(Quoting quoting) Gets template for XML exports as DOM.
org.w3c.dom.Document	getXmlTemplateAsDocument(java.lang.String xmlTemplate, Quoting quoting) Gets template for XML exports as DOM.
int	hashCode() The hash-code.
boolean	isArtifical() Gets whether this table is artificial (i.e. does not represent a table in a database).
boolean	isDistinct() Gets whether this table is a distinct join over several tables (needed for counting of column values).
boolean	isExcludedFromDeletion()
void	setColumns(java.util.List<Column> columns) Sets columns.
void	setIsArtifical(boolean isArtifical) Sets whether this table is artificial (i.e. does not represent a table in a database).
void	setIsDistinct(boolean isDistinct) Sets whether this table is a distinct join over several tables (needed for counting of column values).
void	setOriginalName(java.lang.String originalName) Sets the original table-name.
void	setXmlTemplate(java.lang.String xmlTemplate) Sets template for XML exports.
void	setXmlTemplateInternal(java.lang.String xmlTemplate) Sets template for XML exports (for internal uses/GUI only).
java.lang.String	toString() Stringifies the table.
java.util.Set<Table>	unrestrictedClosure() Gets the closure of the table, ignoring restrictions.

Methods inherited from class net.sf.jailer.datamodel.ModelElement

getAuthor, setAuthor

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

primaryKey

public final PrimaryKey primaryKey

The primary-key of the table.

associations

public final java.util.List<Association> associations

Associations to other tables.

upsert

public java.lang.Boolean upsert

Use upsert (merge) or insert-statement for entities of this table in export-script.

defaultUpsert

public final boolean defaultUpsert

Data model default for export mode.

excludeFromDeletion

public java.lang.Boolean excludeFromDeletion

Exclude from Deletion?

defaultExcludeFromDeletion

public final boolean defaultExcludeFromDeletion

Data Model default for Exclude from Deletion.

Constructor Detail

Table

public Table(java.lang.String name,
             PrimaryKey primaryKey,
             boolean defaultUpsert,
             boolean defaultExcludeFromDeletion)

Constructor.

Parameters:

name - the table-name

primaryKey - the names of the primary-key columns

defaultUpsert - data model default for export mode

Method Detail

getName

public java.lang.String getName()

Gets the table name.

Returns:

the table name

getUpsert

public java.lang.Boolean getUpsert()

Gets export modus.

Returns:

Boolean.TRUE for upsert/merge, Boolean.FALSE for insert

setColumns

public void setColumns(java.util.List<Column> columns)

Sets columns.

Parameters:

columns - list of table columns

getColumns

public java.util.List<Column> getColumns()

Gets columns.

Returns:

list of table columns

equals

public boolean equals(java.lang.Object other)

Compares tables.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

The hash-code.

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Stringifies the table.

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(Table o)

Specified by:

compareTo in interface java.lang.Comparable<Table>

closure

public java.util.Set<Table> closure()

Gets the closure of the table.

Returns:

closure of the table (all tables associated (in-)direct with table)

closure

public java.util.Set<Table> closure(java.util.Set<Table> tablesToIgnore)

Gets the closure of the table.

Parameters:

tablesToIgnore - ignore this tables

Returns:

closure of the table (all tables associated (in-)direct with table)

closure

public java.util.Set<Table> closure(java.util.Set<Table> tablesToIgnore,
                                    java.util.Map<Table,java.lang.Integer> distances)

Gets the closure of the table.

Parameters:

tablesToIgnore - ignore this tables

distances - put distances into it

Returns:

closure of the table (all tables associated (in-)direct with table)

unrestrictedClosure

public java.util.Set<Table> unrestrictedClosure()

Gets the closure of the table, ignoring restrictions.

Returns:

closure of the table (all tables associated (in-)directly with table)

setXmlTemplateInternal

public void setXmlTemplateInternal(java.lang.String xmlTemplate)

Sets template for XML exports (for internal uses/GUI only).

setXmlTemplate

public void setXmlTemplate(java.lang.String xmlTemplate)

Sets template for XML exports.

getXmlTemplate

public java.lang.String getXmlTemplate()

Gets template for XML exports.

getXmlTemplateAsDocument

public org.w3c.dom.Document getXmlTemplateAsDocument(Quoting quoting)
                                              throws javax.xml.parsers.ParserConfigurationException,
                                                     org.xml.sax.SAXException,
                                                     java.io.IOException

Gets template for XML exports as DOM.

Throws:

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.io.IOException

getDefaultXmlTemplate

public org.w3c.dom.Document getDefaultXmlTemplate(Quoting quoting)
                                           throws javax.xml.parsers.ParserConfigurationException,
                                                  org.xml.sax.SAXException,
                                                  java.io.IOException

Gets default template for XML exports as DOM.

Throws:

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.io.IOException

getXmlTemplateAsDocument

public org.w3c.dom.Document getXmlTemplateAsDocument(java.lang.String xmlTemplate,
                                                     Quoting quoting)
                                              throws javax.xml.parsers.ParserConfigurationException,
                                                     org.xml.sax.SAXException,
                                                     java.io.IOException

Gets template for XML exports as DOM.

Throws:

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.io.IOException

getOriginalSchema

public java.lang.String getOriginalSchema(java.lang.String defaultSchema)

Gets un-mapped schema name of table.

Parameters:

defaultSchema - the default schema to return if table name is unqualified

Returns:

schema name

getSchema

public java.lang.String getSchema(java.lang.String defaultSchema)

Gets mapped schema name of table.

Parameters:

defaultSchema - the default schema to return if table name is unqualified

Returns:

schema name

getUnqualifiedName

public java.lang.String getUnqualifiedName()

Gets unqualified name of table.

Returns:

unqualified name of table

setOriginalName

public void setOriginalName(java.lang.String originalName)

Sets the original table-name. Differs from name if a source-schema-mapping has been applied to the name.

Parameters:

originalName - the original name

getOriginalName

public java.lang.String getOriginalName()

Gets the original table-name. Differs from name if a source-schema-mapping has been applied to the name.

Returns:

the original name

getOrdinal

public int getOrdinal()

Gets unique number of this table to be used as type discriminator in JAILER_ENTITY table.

Returns:

unique number

getSelectionClause

public java.util.List<Column> getSelectionClause()

Gets all non-virtual columns of the table in the order in which they are selected.

Returns:

all non-virtual columns of the table in the order in which they are selected

isExcludedFromDeletion

public boolean isExcludedFromDeletion()

clearSessionProperties

public static void clearSessionProperties(Session session)

getNonVirtualPKColumns

public java.util.List<Column> getNonVirtualPKColumns(Session session)

Gets non-virtual and non-filtered primary-key columns.

Parameters:

session - the session

Returns:

non-virtual and non-filtered primary-key columns

setIsArtifical

public void setIsArtifical(boolean isArtifical)

Sets whether this table is artificial (i.e. does not represent a table in a database).

Parameters:

isArtifical - value to set

isArtifical

public boolean isArtifical()

Gets whether this table is artificial (i.e. does not represent a table in a database).

setIsDistinct

public void setIsDistinct(boolean isDistinct)

Sets whether this table is a distinct join over several tables (needed for counting of column values).

Parameters:

isDistinct - value to set

isDistinct

public boolean isDistinct()

Gets whether this table is a distinct join over several tables (needed for counting of column values).