net.windward.datasource
Class MetaDataElement

java.lang.Object
  |
  +--net.windward.datasource.MetaDataElement

public class MetaDataElement

extends java.lang.Object

This represents a node of metadata used by AutoTag. This data can be SQL tables, XML lists, or a data element in a user created datasource.

Version:

5.0 4/20/07

Field Summary

static int	DATA_BLOB A binary BLOB.
static int	DATA_DATETIME A date and time.
static int	DATA_DECIMAL A decimal number (usually money).
static int	DATA_DOUBLE A floating point number.
static int	DATA_LONG An integer.
static int	DATA_OTHER A type of data that does not fit any of the pre-defined types.
static int	DATA_STRING A string.
static int	TYPE_ATTRIBUTE An XML attribute or equivilent.
static int	TYPE_COLUMN A SQL column or equivilent.
static int	TYPE_NODE An XML node or equivilent.
static int	TYPE_OTHER A type of node that does not fit any of the pre-defined types.
static int	TYPE_STAT The statistics of a query such as the number of nodes returned.
static int	TYPE_STATUS The status of a datasource such as an error was returned on a query.
static int	TYPE_TABLE A SQL table or equivilent.
static int	TYPE_TABLES A SQL set of tables or equivilent.

Constructor Summary

MetaDataElement(java.lang.String name, java.lang.String select, java.lang.String description, int dataType, int metaType)
Create a MetaData object.

MetaDataElement(java.lang.String name, java.lang.String select, java.lang.String description, int dataType, int metaType, MetaDataElement[] children)
Create a MetaData object.

Method Summary

MetaDataElement[]	getChildren() The children nodes of this node.
int	getDataType() One of the DATA_* constants.
java.lang.String	getDescription() The description of the node from the datasource metadata.
int	getMetaType() One of the TYPE_* constants.
java.lang.String	getName() The name of the node such as the table or column name.
java.lang.String	getSelect() The select that created this node.
void	setChildren(MetaDataElement[] children) The children nodes of this node.

Methods inherited from class java.lang.Object

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

Field Detail

DATA_OTHER

public static final int DATA_OTHER

A type of data that does not fit any of the pre-defined types.

DATA_LONG

public static final int DATA_LONG

An integer.

DATA_DOUBLE

public static final int DATA_DOUBLE

A floating point number.

DATA_STRING

public static final int DATA_STRING

A string.

DATA_BLOB

public static final int DATA_BLOB

A binary BLOB.

DATA_DECIMAL

public static final int DATA_DECIMAL

A decimal number (usually money).

DATA_DATETIME

public static final int DATA_DATETIME

A date and time.

TYPE_OTHER

public static final int TYPE_OTHER

A type of node that does not fit any of the pre-defined types.

TYPE_TABLES

public static final int TYPE_TABLES

A SQL set of tables or equivilent.

TYPE_TABLE

public static final int TYPE_TABLE

A SQL table or equivilent.

TYPE_COLUMN

public static final int TYPE_COLUMN

A SQL column or equivilent.

TYPE_NODE

public static final int TYPE_NODE

An XML node or equivilent.

TYPE_ATTRIBUTE

public static final int TYPE_ATTRIBUTE

An XML attribute or equivilent.

TYPE_STATUS

public static final int TYPE_STATUS

The status of a datasource such as an error was returned on a query.

TYPE_STAT

public static final int TYPE_STAT

The statistics of a query such as the number of nodes returned.

Constructor Detail

MetaDataElement

public MetaDataElement(java.lang.String name,
                       java.lang.String select,
                       java.lang.String description,
                       int dataType,
                       int metaType)

Create a MetaData object.

Parameters:

name - The name of the node such as the table or column name.

select - The select that created this node. This can be null.

description - The description of the node from the datasource metadata. Null if there is no description.

dataType - One of the DATA_* constants.

metaType - One of the TYPE_* constants.

MetaDataElement

public MetaDataElement(java.lang.String name,
                       java.lang.String select,
                       java.lang.String description,
                       int dataType,
                       int metaType,
                       MetaDataElement[] children)

Create a MetaData object.

Parameters:

name - The name of the node such as the table or column name.

select - The select that created this node. This can be null.

description - The description of the node from the datasource metadata. Null if there is no description.

dataType - One of the DATA_* constants.

metaType - One of the TYPE_* constants.

children - The children nodes of this node. For example the column nodes are children of the table node.

Method Detail

getName

public java.lang.String getName()

The name of the node such as the table or column name.

Returns:

The name of the node such as the table or column name.

getSelect

public java.lang.String getSelect()

The select that created this node. This can be null.

Returns:

The select that created this node. This can be null.

getDescription

public java.lang.String getDescription()

The description of the node from the datasource metadata. Null if there is no description.

Returns:

The description of the node from the datasource metadata. Null if there is no description.

getDataType

public int getDataType()

One of the DATA_* constants.

Returns:

One of the DATA_* constants.

getMetaType

public int getMetaType()

One of the TYPE_* constants.

Returns:

One of the TYPE_* constants.

getChildren

public MetaDataElement[] getChildren()

The children nodes of this node. For example the column nodes are children of the table node.

Returns:

The children nodes of this node. For example the column nodes are children of the table node.

setChildren

public void setChildren(MetaDataElement[] children)

The children nodes of this node. For example the column nodes are children of the table node.

Parameters:

children - The children nodes of this node. For example the column nodes are children of the table node.