Package mgui.datasources

Class DataTableSet

java.lang.Object

mgui.interfaces.AbstractInterfaceObject

mgui.datasources.DataTableSet

All Implemented Interfaces:

InterfaceObject, NamedObject, TreeObject, CleanableObject, XMLObject, IconObject

public class DataTableSet
extends AbstractInterfaceObject
implements IconObject, XMLObject

Object stores a list of DataTable objects, all representing tables in a single DataSource

Since:

1.0

Version:

1.0

Author:

Andrew Reid

Nested Class Summary

Nested classes/interfaces inherited from interface mgui.interfaces.xml.XMLObject

XMLObject.XMLEncoding, XMLObject.XMLType

Field Summary

Fields

Modifier and Type	Field	Description
protected DataSource	data_source
protected java.util.HashMap<java.lang.String,DataTable>	table_map

Fields inherited from class mgui.interfaces.AbstractInterfaceObject

isDestroyed, tree_nodes

Constructor Summary

Constructors

Constructor	Description
DataTableSet()
DataTableSet(DataSource ds)

Method Summary

Modifier and Type	Method	Description
void	addTable(DataTable t)
int	findTable(DataTable t)
DataSource	getDataSource()
java.lang.String	getDTD()	Returns the Data Type Declaration (DTD) for this object's XML representation
java.lang.String	getLocalName()	Returns the local name associated with this XML object.
javax.swing.Icon	getObjectIcon()	Returns the Icon associated with this object.
java.lang.String	getShortXML(int tab)	Returns a short XML representation of this object.
DataTable	getTable(java.lang.String name)
java.util.ArrayList<DataTable>	getTables()
java.lang.String	getTreeLabel()	Returns the label text to appear in a tree node.
java.lang.String	getXML()	Returns this object's XML representation as a single string.
java.lang.String	getXML(int tab)	Returns this object's XML representation as a single string.
java.lang.String	getXMLSchema()	Returns the XML schema for this object's XML representation
void	handleXMLElementEnd(java.lang.String localName)	Handles the end of an XML element.
void	handleXMLElementStart(java.lang.String localName, org.xml.sax.Attributes attributes, XMLObject.XMLType type)	Handles the start of an XML element.
void	handleXMLString(java.lang.String s)	Handles a string within an XML element.
void	removeTable(DataTable t)
void	setDataSource(DataSource ds)
boolean	setFromMetaData()	Sets this table set from the information contained in its data source's metadata.
boolean	setFromMetaData(boolean overwrite_existing)	Sets this table set from the information contained in its data source's metadata.
void	setTreeNode(InterfaceTreeNode treeNode)	Sets the children for this node's InterfaceTreeNode.
java.lang.String	toString()
void	writeXML(int tab, java.io.Writer writer)	Writes the XML representation of this object to file.
void	writeXML(int tab, java.io.Writer writer, ProgressUpdater progress_bar)	Writes the XML representation of this object to file, as XMLType.Normal.
void	writeXML(int tab, java.io.Writer writer, XMLOutputOptions options, ProgressUpdater progress_bar)	Writes the XML representation of this object to file.

Methods inherited from class mgui.interfaces.AbstractInterfaceObject

clean, destroy, getName, isDestroyed, issueTreeNode, setName, updateTreeNodes

Methods inherited from class java.lang.Object

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

Field Details

data_source

protected DataSource data_source

table_map

protected java.util.HashMap<java.lang.String,DataTable> table_map

Constructor Details

DataTableSet

public DataTableSet()

DataTableSet

public DataTableSet(DataSource ds)

Method Details

setDataSource

public void setDataSource(DataSource ds)

getTables

public java.util.ArrayList<DataTable> getTables()

getObjectIcon

public javax.swing.Icon getObjectIcon()

Description copied from interface: IconObject

Returns the Icon associated with this object.

Specified by:

getObjectIcon in interface IconObject

Returns:

setFromMetaData

public boolean setFromMetaData()
                        throws DataSourceException

Sets this table set from the information contained in its data source's metadata.

Returns:

Throws:

DataSourceException

setFromMetaData

public boolean setFromMetaData(boolean overwrite_existing)
                        throws DataSourceException

Sets this table set from the information contained in its data source's metadata.

Parameters:

overwrite_existing - If true, all existing tables will be removed; otherwise, pre-existing tables will not be altered.

Returns:

Throws:

DataSourceException

getDataSource

public DataSource getDataSource()

addTable

public void addTable(DataTable t)

getTable

public DataTable getTable(java.lang.String name)

findTable

public int findTable(DataTable t)

removeTable

public void removeTable(DataTable t)

setTreeNode

public void setTreeNode(InterfaceTreeNode treeNode)

Description copied from interface: TreeObject

Sets the children for this node's InterfaceTreeNode.

Specified by:

setTreeNode in interface TreeObject

Overrides:

setTreeNode in class AbstractInterfaceObject

getTreeLabel

public java.lang.String getTreeLabel()

Description copied from interface: TreeObject

Returns the label text to appear in a tree node.

Specified by:

getTreeLabel in interface TreeObject

Overrides:

getTreeLabel in class AbstractInterfaceObject

Returns:

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getDTD

public java.lang.String getDTD()

Description copied from interface: XMLObject

Returns the Data Type Declaration (DTD) for this object's XML representation

See http://en.wikipedia.org/wiki/Document_Type_Definition for a description.

Specified by:

getDTD in interface XMLObject

Returns:

getXMLSchema

public java.lang.String getXMLSchema()

Description copied from interface: XMLObject

Returns the XML schema for this object's XML representation

See http://en.wikipedia.org/wiki/XML_schema.

Specified by:

getXMLSchema in interface XMLObject

Returns:

getXML

public java.lang.String getXML()

Description copied from interface: XMLObject

Returns this object's XML representation as a single string. NOTE: this is not feasible for larger objects and containers, thus may not be implemented for these objects. Use the XMLObject.writeXML(int,java.io.Writer,mgui.io.standard.xml.XMLOutputOptions,mgui.interfaces.ProgressUpdater) functions to write larger objects to file.

Specified by:

getXML in interface XMLObject

Returns:

getXML

public java.lang.String getXML(int tab)

Description copied from interface: XMLObject

Returns this object's XML representation as a single string. NOTE: this is not feasible for larger objects and containers, thus may not be implemented for these objects. Use the XMLObject.writeXML(int,java.io.Writer,mgui.io.standard.xml.XMLOutputOptions,mgui.interfaces.ProgressUpdater) functions to write larger objects to file.

Specified by:

getXML in interface XMLObject

Parameters:

tab - The number of tabs to place before the opening XML wrapper

Returns:

handleXMLElementStart

public void handleXMLElementStart(java.lang.String localName,
org.xml.sax.Attributes attributes,
XMLObject.XMLType type)
                           throws org.xml.sax.SAXException

Description copied from interface: XMLObject

Handles the start of an XML element.

Specified by:

handleXMLElementStart in interface XMLObject

Parameters:

localName - Local name of the element

attributes - Set of element attributes

type - The XMLType of this element

Throws:

org.xml.sax.SAXException

handleXMLElementEnd

public void handleXMLElementEnd(java.lang.String localName)
                         throws org.xml.sax.SAXException

Description copied from interface: XMLObject

Handles the end of an XML element.

Specified by:

handleXMLElementEnd in interface XMLObject

Parameters:

localName - Local name of the element

Throws:

org.xml.sax.SAXException

handleXMLString

public void handleXMLString(java.lang.String s)
                     throws org.xml.sax.SAXException

Description copied from interface: XMLObject

Handles a string within an XML element.

Specified by:

handleXMLString in interface XMLObject

Parameters:

s - String to handle

Throws:

org.xml.sax.SAXException

getLocalName

public java.lang.String getLocalName()

Description copied from interface: XMLObject

Returns the local name associated with this XML object.

Specified by:

getLocalName in interface XMLObject

Returns:

writeXML

public void writeXML(int tab,
java.io.Writer writer,
XMLOutputOptions options,
ProgressUpdater progress_bar)
              throws java.io.IOException

Description copied from interface: XMLObject

Writes the XML representation of this object to file. The basic contract for this method is that it should not write a newline character at its start or end. The default format of XMLFormat.Ascii will be used.

Specified by:

writeXML in interface XMLObject

Parameters:

tab - The number of tabs to place before the XML text

writer - The writer

options - XMLOutputOptions defining the write parameters

progress_bar - Optional progress updater (may be null)

Throws:

java.io.IOException

writeXML

public void writeXML(int tab,
java.io.Writer writer,
ProgressUpdater progress_bar)
              throws java.io.IOException

Description copied from interface: XMLObject

Writes the XML representation of this object to file, as XMLType.Normal. The default format of XMLFormat.Ascii will be used. The basic contract for this method is that it should not write a newline character at its start or end.

Specified by:

writeXML in interface XMLObject

Parameters:

tab - The number of tabs to place before the XML text

writer - The writer

progress_bar - Optional progress updater (may be null)

Throws:

java.io.IOException

writeXML

public void writeXML(int tab,
java.io.Writer writer)
              throws java.io.IOException

Description copied from interface: XMLObject

Writes the XML representation of this object to file. The basic contract for this method is that it should not write a newline character at its start or end. The default format of XMLFormat.Ascii will be used.

Specified by:

writeXML in interface XMLObject

Parameters:

tab - The number of tabs to place before the XML text

writer - The writer

Throws:

java.io.IOException

getShortXML

public java.lang.String getShortXML(int tab)

Description copied from interface: XMLObject

Returns a short XML representation of this object.

Specified by:

getShortXML in interface XMLObject

Returns: