EmearldJB Schema Reference

At the heart of EmeraldJB is the XML Schema. It is the primary focus of both the developer and generator. This page is the main reference for all XML tags in the EmeraldJB schema. Where the other documenation is focused on the backround of EmeraldJB this page is focused on the semantics of each and ever XML tag. It is essentically the Javadoc of the EmeraldJB schema.

A Diagram
A list of children this tag uses
A list of tags that reference this one
A list of Attributes
Other information
A brief description

Elements

DEPRECATED

DESCRIPTION

DEVELOPER

ENTITY

FIELD

FIELD_SPEC

FILE_HEADER

FINDER

FOREIGN_KEY

FROM

HEADER

INDEX

JAVADOC

MEMBER

MEMBER_SPEC

NUGGET

PARAMS

PATTERN

PRIMARY_KEY

PROJECT

SECTION

SEE

SINCE

SQL

SRC

element DEPRECATED

diagram

used by

element

JAVADOC

annotation

documentation

Contains the deprecation reason, if this element is deprecated.

element DESCRIPTION

diagram

used by

element

JAVADOC

annotation

documentation

Contains the description for this element. Allows HTML tags.

element DEVELOPER

diagram

used by

element

HEADER

annotation

documentation

The name of the developer.

element ENTITY

diagram

children

PATTERN JAVADOC MEMBER MEMBER_SPEC PRIMARY_KEY INDEX FOREIGN_KEY FINDER

used by

element

SECTION

attributes

Name

Use

Default

Fixed

Annotation

NAME

required

documentation

The name of the table, which is used as the basis for the associated Java access class names.

annotation

documentation

A Table definition

element FIELD

diagram

used by

element

NUGGET

attributes

Name

Use

Default

Fixed

Annotation

NAME

required

documentation

The name of this element, which is used as the View field name.

TYPE

required

documentation

The type of the field.

SRC

required

documentation

The SQL that defines the field selection criteria, within quotes.  For complex SRC values, use the FIELD_SPEC tag.

annotation

documentation

A short-hand nugget field.  Attributes are: NAME, TYPE, and  SRC

datatypes

Type	Java Type(s)	java.sql accessor / setter	MySQL Column Type
int	int, Integer	getInt / setInt	INTEGER
long	long, Long	getLong / setLong	BIGINT
short	short, Short	getShort / setShort	SMALLINT
boolean	boolean, Boolean	getShort / setShort	SMALLINT
float	float, Float	getFloat / setShort	FLOAT
double	double, Double	getDouble / setDouble	DOUBLE
String	String	getString / setString	If len < 255 VARCHAR(len) else BLOB
date	java.sql.Date	getDate / setDate	DATE
time	java.sql.Time	getTime / setTime	TIME
timestamp	java.sql.Timestamp	getTimestamp / setTimestamp	TIMESTAMP

element FIELD_SPEC

diagram

children

PATTERN JAVADOC SRC

used by

element

NUGGET

attributes

Name

Use

Default

Fixed

Annotation

NAME

required

documentation

The name of this element, which is used as the View field name.

TYPE

required

documentation

The type of the field.

annotation

documentation

A long-hand nugget field, with Javadoc and complex SRC capability.  Same attributes as FIELD

datatypes

Type	Java Type(s)	java.sql accessor / setter	MySQL Column Type
int	int, Integer	getInt / setInt	INTEGER
long	long, Long	getLong / setLong	BIGINT
short	short, Short	getShort / setShort	SMALLINT
boolean	boolean, Boolean	getShort / setShort	SMALLINT
float	float, Float	getFloat / setShort	FLOAT
double	double, Double	getDouble / setDouble	DOUBLE
String	String	getString / setString	If len < 255 VARCHAR(len) else BLOB
date	java.sql.Date	getDate / setDate	DATE
time	java.sql.Time	getTime / setTime	TIME
timestamp	java.sql.Timestamp	getTimestamp / setTimestamp	TIMESTAMP

element FILE_HEADER

diagram

used by

element

HEADER

annotation

documentation

Contains the text to be included as part of each generated Java file.

element FINDER

diagram

children

PATTERN JAVADOC PARAMS FROM SQL

used by

elements

ENTITY NUGGET

attributes

Name

Use

Default

Fixed

Annotation

NAME

required

documentation

The name of this element, which is used as the Java method name.

SINGLETON

optional

FALSE

documentation

A boolean flag indicating that this finder returns a single entity, which affects the return value.

DISTINCT

optional

FALSE

documentation

A boolean flag indicating that this finder returns distinct values from the SELECT.

annotation

documentation

An arbitrary SQL finder function.  The name is the actual Java finder method name.

element FOREIGN_KEY

diagram

used by

element

ENTITY

attributes

Name

Use

Default

Fixed

Annotation

NAME

required

documentation

The name of the foreign key constraint.

COLS

required

documentation

The comma-separated list of columns that comprise the foreign key.

REFERENCES

required

documentation

The literal string of the foreign key, in the form TABLE(COL1,COL2)

annotation

documentation

A foreign key within an Entity.  Attributes are NAME, COLS and REFERENCES.

element FROM

diagram

used by

elements

FINDER NUGGET

annotation

documentation

The optionsl table definition within the finder element.

element HEADER

diagram

children

DEVELOPER FILE_HEADER

used by

element

SECTION

annotation

documentation

Header information

element INDEX

diagram

used by

element

ENTITY

attributes

Name

Use

Default

Fixed

Annotation

NAME

required

documentation

The name of the index constraint.

COLS

required

documentation

The comma-separated list of columns that comprise the index.

UNIQUE

optional

FALSE

documentation

The boolean flag indicating whether this index has unique keys.

annotation

documentation

An index definition within an Entity. Attributes are NAME, COLS and UNIQUE.

element JAVADOC

diagram

children

DESCRIPTION PATTERN SEE SINCE DEPRECATED

used by

elements

ENTITY FIELD_SPEC FINDER MEMBER_SPEC NUGGET

annotation

documentation

The tag for JavaDoc-related documentation.

element MEMBER

diagram

used by

element

ENTITY

attributes

Name

Use

Default

Fixed

Annotation

NAME

required

documentation

The name of the column, which is also used as the basis for the data access member.

TYPE

required

documentation

The type of the member.

FROM_SEQ

optional

FALSE

documentation

A string attribute specifying the sequence for autogenerated int columns. Ignored if set to FALSE.

NULL_ALLOWED

optional

TRUE

documentation

A boolean flag indicating that this member allows null values in the database.

DIRTY_CHECK

optional

FALSE

documentation

A boolean flag indicating that this int member is used to check for dirty write attempts.

DEFAULT

documentation

The default value for the member.

COL_LEN

required for (String)

documentation

The number of columns for a string member.

annotation

documentation

An short-hand Entity column.  Attributes are: NAME, TYPE, FROM_SEQ, NULL_ALLOWED, DIRTY_CHECK, DEFAULT, and COL_LEN.

datatypes

Type	Java Type(s)	java.sql accessor / setter	MySQL Column Type
int	int, Integer	getInt / setInt	INTEGER
long	long, Long	getLong / setLong	BIGINT
short	short, Short	getShort / setShort	SMALLINT
boolean	boolean, Boolean	getShort / setShort	SMALLINT
float	float, Float	getFloat / setShort	FLOAT
double	double, Double	getDouble / setDouble	DOUBLE
String	String	getString / setString	If len < 255 VARCHAR(len) else BLOB
date	java.sql.Date	getDate / setDate	DATE
time	java.sql.Time	getTime / setTime	TIME
timestamp	java.sql.Timestamp	getTimestamp / setTimestamp	TIMESTAMP

element MEMBER_SPEC

diagram

children

PATTERN JAVADOC

used by

element

ENTITY

attributes

Name

Use

Default

Fixed

Annotation

NAME

required

documentation

The name of the column, which is also used as the basis for the data access member.

TYPE

required

documentation

The type of the member.

FROM_SEQ

optional

FALSE

documentation

A string attribute specifying the sequence for autogenerated int columns. Ignored if set to FALSE.

NULL_ALLOWED

optional

TRUE

documentation

A boolean flag indicating that this member allows null values in the database.

DIRTY_CHECK

optional

FALSE

documentation

A boolean flag indicating that this int member is used to check for dirty write attempts.

DEFAULT

documentation

The default value for the member.

COL_LEN

documentation

The number of columns for a string member.

annotation

documentation

An long-hand Entity column, allowing JavaDoc.  Attributes are: NAME, TYPE, FROM_SEQ, NULL_ALLOWED, DIRTY_CHECK, DEFAULT, and COL_LEN.

datatypes

Type	Java Type(s)	java.sql accessor / setter	MySQL Column Type
int	int, Integer	getInt / setInt	INTEGER
long	long, Long	getLong / setLong	BIGINT
short	short, Short	getShort / setShort	SMALLINT
boolean	boolean, Boolean	getShort / setShort	SMALLINT
float	float, Float	getFloat / setShort	FLOAT
double	double, Double	getDouble / setDouble	DOUBLE
String	String	getString / setString	If len < 255 VARCHAR(len) else BLOB
date	java.sql.Date	getDate / setDate	DATE
time	java.sql.Time	getTime / setTime	TIME
timestamp	java.sql.Timestamp	getTimestamp / setTimestamp	TIMESTAMP

element NUGGET

diagram

children

PATTERN JAVADOC FIELD FIELD_SPEC FROM FINDER

used by

element

SECTION

attributes

Name

Use

Default

Fixed

Annotation

NAME

required

documentation

The name of this nugget, which corresponds to the root Java name.

annotation

documentation

A View definition that allows table joins and subset select values.

element PARAMS

diagram

used by

element

FINDER

annotation

documentation

The Java signature for the finder method, with named parameteres.

element PATTERN

diagram

used by

elements

ENTITY FIELD_SPEC FINDER JAVADOC MEMBER_SPEC NUGGET PROJECT SECTION

attributes

Name

Use

Default

Fixed

Annotation

NAME

required

documentation

The name of the pattern, used as a lookup key in the generators.

VALUE

required

documentation

The value of the pattern to use, until overridden deeper in the spec.

OVERRIDABLE

optional

FALSE

documentation

A boolean flag indicating that this pattern may be overridden lower in project structure.

annotation

documentation

Specific hints for the generators

element PRIMARY_KEY

diagram

used by

element

ENTITY

attributes

Name

Use

Default

Fixed

Annotation

NAME

required

documentation

The name of the primary key constraint.

COLS

required

documentation

The comma-separated list of columns that comprise the primary key.

annotation

documentation

The primary key definition within an Entity.  Attributes are COLS.

element PROJECT

diagram

children

PATTERN SECTION

attributes

Name

Use

Default

Fixed

Annotation

NAME

required

documentation

The name of this element.

annotation

documentation

The collection of sections that make up a complete project.

element SECTION

diagram

children

HEADER PATTERN ENTITY NUGGET

used by

element

PROJECT

attributes

Name

Use

Default

Fixed

Annotation

NAME

required

documentation

The name of the section.

annotation

documentation

The container for relatedl Emeraljdjb tags.

element SEE

diagram

used by

element

JAVADOC

annotation

documentation

The contents o a Javadoc @see tag.

element SINCE

diagram

used by

element

JAVADOC

annotation

documentation

The contents of the JavaDoc @since tag.

element SQL

diagram

used by

element

FINDER

annotation

documentation

The SQL code for the Finder WHERE clause

element SRC

diagram

used by

element

FIELD_SPEC

annotation

documentation

The SQL source of a nugget field.