org.ecoinformatics.seek.querybuilder

Class DBUIUtils

java.lang.Object

org.ecoinformatics.seek.querybuilder.DBUIUtils

public class DBUIUtils
extends java.lang.Object

A set of uttiliy methods (all static)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALL_FIELDS
static java.lang.String	NO_NAME

Constructor Summary

Constructors

Constructor and Description
DBUIUtils()

Method Summary

Modifier and Type	Method and Description
static org.w3c.dom.Document	convertXMLStr2DOM(java.lang.String aXMLStr) Convert/Parses an XML string into a DOM tree
static void	fillFieldCombobox(DSSchemaIFace aSchema, java.lang.String aTableName, javax.swing.JComboBox aCBX, boolean aInclAstrick) Helper method to fill combobox with the list of field names from a "named" table schema
static void	fillTableCombobox(DSSchemaIFace aSchema, javax.swing.JComboBox aCBX) Helper method to fill combobox with the list of table names from the schema
static java.lang.String	findAttrValue(org.w3c.dom.Node aNode, java.lang.String aAttr) ------------------------------------------------------------ Gets an attribute value for the node.
static java.lang.String	findAttrValueForNode(org.w3c.dom.Node aNode, java.lang.String aName, java.lang.String aAttr) ------------------------------------------------------------ Gets an attribute value for the named node.
static org.w3c.dom.Node	findNode(org.w3c.dom.Node aNode, java.lang.String aName) ------------------------------------------------------------ Finds the first node of a given type
static java.lang.String	findNodeValue(org.w3c.dom.Node aNode, java.lang.String aName) ------------------------------------------------------------ Gets the value of the named node
static java.lang.String	fixNameWithSpaces(java.lang.String aName) Add brackets around names with spaces
static DSTableFieldIFace	getFieldByName(DSSchemaIFace aSchema, java.lang.String aTableName, java.lang.String aFieldName) Returns a DBTableField object by name
static DSTableFieldIFace	getFieldByName(DSTableIFace aTable, java.lang.String aName) Returns a DBTableField object by name
static java.lang.String	getFullFieldName(DBTableField aField) Returns the full table name/field name concatenated
static java.lang.String	getFullFieldName(java.lang.String aTblName, java.lang.String aFieldName) Returns the full table name/field name concatenated
static int	getIntAttrId(org.w3c.dom.Node aNode, java.lang.String aAttrName) Looks up the attr and returns the int of it or returns -1
static java.lang.String	getNodeValue(org.w3c.dom.Node aNode) ------------------------------------------------------------ Gets the String value of a node.
static java.lang.String	getSpaces(int aDepth) Returns the desired number of spaces for the depth (usually *2)
protected static DSTableIFace	getTableByName(DSSchemaIFace aSchema, java.lang.String aName) Returns a table by name
static DSTableFieldIFace	isTableFieldName(DSSchemaIFace aSchema, java.lang.String aName, java.lang.StringBuffer aTableName) Returns true if the name is of format "table name"."
static void	printNode(org.w3c.dom.Node aNode, int aLevel) Prints a DOM Tree (recursive)
static org.w3c.dom.Document	readXMLFile2DOM(java.lang.String aFileName) Reads in an XML document and returns the Document node of the DOM tree
static java.lang.String	readXMLFile2Str(java.lang.String aFileName) Reads in an XML document and returns a String of the file's contents

Methods inherited from class java.lang.Object

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

Field Detail

ALL_FIELDS

public static final java.lang.String ALL_FIELDS

See Also:

Constant Field Values

NO_NAME

public static final java.lang.String NO_NAME

See Also:

Constant Field Values

Constructor Detail

DBUIUtils

public DBUIUtils()

Method Detail

fillFieldCombobox

public static void fillFieldCombobox(DSSchemaIFace aSchema,
                                     java.lang.String aTableName,
                                     javax.swing.JComboBox aCBX,
                                     boolean aInclAstrick)

Helper method to fill combobox with the list of field names from a "named" table schema

Parameters:

aSchema - the schema

aTableName - the table name in the schema

aCBX - the comboxbox

aInclAstrick - if the table schema includes a field with an astrick "*" then include it also

fillTableCombobox

public static void fillTableCombobox(DSSchemaIFace aSchema,
                                     javax.swing.JComboBox aCBX)

Helper method to fill combobox with the list of table names from the schema

Parameters:

aSchema - the schema

aCBX - the comboxbox

fixNameWithSpaces

public static java.lang.String fixNameWithSpaces(java.lang.String aName)

Add brackets around names with spaces

Parameters:

aName - the name to be changed

Returns:

a name with brackets, but only if necessary

getFullFieldName

public static java.lang.String getFullFieldName(DBTableField aField)

Returns the full table name/field name concatenated

Parameters:

aField - object for which to get the names

Returns:

the full name

getFullFieldName

public static java.lang.String getFullFieldName(java.lang.String aTblName,
                                                java.lang.String aFieldName)

Returns the full table name/field name concatenated

Parameters:

aTblName - the table name

aFieldName - the field name

Returns:

the concatenated name

getTableByName

protected static DSTableIFace getTableByName(DSSchemaIFace aSchema,
                                             java.lang.String aName)

Returns a table by name

Parameters:

aName - name of table to be found

getFieldByName

public static DSTableFieldIFace getFieldByName(DSTableIFace aTable,
                                               java.lang.String aName)

Returns a DBTableField object by name

Parameters:

aTable - table to look into

aName - name of field to be found

Returns:

field object

getFieldByName

public static DSTableFieldIFace getFieldByName(DSSchemaIFace aSchema,
                                               java.lang.String aTableName,
                                               java.lang.String aFieldName)

Returns a DBTableField object by name

Parameters:

aSchema - schema

aTableName - table name to look into

aFieldName - name of field to be found

Returns:

field object

isTableFieldName

public static DSTableFieldIFace isTableFieldName(DSSchemaIFace aSchema,
                                                 java.lang.String aName,
                                                 java.lang.StringBuffer aTableName)

Returns true if the name is of format "table name"."field name" and the table name and field name are in the schema

Parameters:

aSchema - schema

aName - the full name

aTableName - can be null, or a stringbuffer that will return the name of the table

Returns:

Returns true if the name is of format "table name"."field name" and the table name and field name are in the schema

getSpaces

public static java.lang.String getSpaces(int aDepth)

Returns the desired number of spaces for the depth (usually *2)

Parameters:

aDepth - the depth

Returns:

spaces

getNodeValue

public static java.lang.String getNodeValue(org.w3c.dom.Node aNode)

------------------------------------------------------------ Gets the String value of a node. First checks it's value and if that is null then it checks to see if it has a child node and gets the value of the first child. Assumption: That the first child is a #text node, delibertly NOT checking the first node's type

Parameters:

aNode - Parent to search (should be the document root)

Returns:

Returns the value of the node --------------------------------------------------------------

findNode

public static org.w3c.dom.Node findNode(org.w3c.dom.Node aNode,
                                        java.lang.String aName)

------------------------------------------------------------ Finds the first node of a given type

Parameters:

aNode - Parent to search (should be the document root)

aName - Name of node to find

Returns:

Returns the node of that name or null --------------------------------------------------------------

findNodeValue

public static java.lang.String findNodeValue(org.w3c.dom.Node aNode,
                                             java.lang.String aName)

------------------------------------------------------------ Gets the value of the named node

Parameters:

aNode - Parent to search (should be the document root)

aName - Name of node to find

Returns:

Returns the node's value as a string --------------------------------------------------------------

findAttrValueForNode

public static java.lang.String findAttrValueForNode(org.w3c.dom.Node aNode,
                                                    java.lang.String aName,
                                                    java.lang.String aAttr)

------------------------------------------------------------ Gets an attribute value for the named node.

Parameters:

aNode - Parent to search (should be the document root)

aName - Name of node to find

aAttr - Name of attribute to return

Returns:

Returns the attribute's value as a string --------------------------------------------------------------

findAttrValue

public static java.lang.String findAttrValue(org.w3c.dom.Node aNode,
                                             java.lang.String aAttr)

------------------------------------------------------------ Gets an attribute value for the node.

Parameters:

aNode - Parent to search (should be the document root)

aAttr - Name of attribute to return

Returns:

Returns the attribute's value as a string --------------------------------------------------------------

getIntAttrId

public static int getIntAttrId(org.w3c.dom.Node aNode,
                               java.lang.String aAttrName)

Looks up the attr and returns the int of it or returns -1

Parameters:

aNode - the node with the attr

Returns:

the int or returns -1

printNode

public static void printNode(org.w3c.dom.Node aNode,
                             int aLevel)

Prints a DOM Tree (recursive)

Parameters:

aNode - parent node of tree to be printed

aLevel - indicates the current indentation level

readXMLFile2Str

public static java.lang.String readXMLFile2Str(java.lang.String aFileName)

Reads in an XML document and returns a String of the file's contents

Parameters:

aFileName - file name of XML file to be read

readXMLFile2DOM

public static org.w3c.dom.Document readXMLFile2DOM(java.lang.String aFileName)

Reads in an XML document and returns the Document node of the DOM tree

Parameters:

aFileName - file name of XML file to be read

convertXMLStr2DOM

public static org.w3c.dom.Document convertXMLStr2DOM(java.lang.String aXMLStr)

Convert/Parses an XML string into a DOM tree

Parameters:

aXMLStr - XML string (document)