Module org.tentackle.model

Package org.tentackle.model.parse

Class AttributeLine

java.lang.Object

org.tentackle.model.parse.Line

org.tentackle.model.parse.SingleLine

org.tentackle.model.parse.AttributeLine

public class AttributeLine
extends SingleLine

The attribute definition line.

An attribute line is defined as follows:

 javaType[<innerType>][(size[,scale])] javaName columnName [comment] [\[options\]]
 

Where:

• javaType - is the java class name or primitive. Allowed types are:
  • primitives: boolean, byte, char, short, int, long, float, double
  • classes: Boolean, Byte, Character, Short, Integer, Long, Float, Double, BigDecimal, BMoney, DMoney, Binary, Date, Time, Timestamp, String
• innerType: optional inner/generic type
• size: optional number of columns or width or non-fractional digits if numeric
• scale: optional scale (numeric types only)
• javaName: the name used in Java sources (must start lowercase)
• columnName: the database column name
• comment: the optional comment
• [options]: the options enclosed in double quotes. Options beginning with an '@' are treated as annotations

Examples:

 long             subsidiaryId    subsidiary_id     subsidiary ID [contextid]
 String(10)       invoiceNo       invoice_no        the unique invoice number [uc]
 Date             invoiceDate     invoice_date      the invoice's date
 long             customerId      customer_id       object ID of the customer [uc]
 String(200)      address         address           the address (multiline) [default 'blah']
 DMoney           total           total             sum (without tax)
 DMoney           tax             tax               tax (vat)
 Timestamp        printed         printed           first printed
 Double(10,2)     someDouble      some_double       digits with scale
 MyType<int>      extra           extra             some application specific type
 

Author:

harald

Constructor Summary

Constructors

Constructor	Description
AttributeLine(Document document, int offset, LineType lineType)	Creates an attribute line. This line always spans only one line.

Method Summary

Modifier and Type	Method	Description
String	getColumnName()	Gets the column name in database table.
String	getComment()	Gets the comment.
String	getInnerType()	Gets the inner type name.
String	getJavaName()	Gets the Java attribute name.
String	getJavaType()	Gets the java type name.
List<String>	getOptions()	Gets the options.
Integer	getScale()	Gets the numeric scale.
Integer	getSize()	Gets the size.
void	parse()	Parses a line.

Methods inherited from class org.tentackle.model.parse.Line

assertParsed, createModelException, createModelException, getDocument, getLength, getLineNumber, getLineType, getOffset, getSourceInfo, getText, setLength, toString

Methods inherited from class java.lang.Object

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

Constructor Details

AttributeLine

public AttributeLine(Document document,
 int offset,
 LineType lineType)

Creates an attribute line.
This line always spans only one line.

Parameters:

document - the whole document

offset - offset to first character within document

lineType - the line type

Method Details

parse

public void parse()
           throws ModelException

Description copied from class: Line

Parses a line.

Overrides:

parse in class SingleLine

Throws:

ModelException - if parsing failed

getJavaType

public String getJavaType()
                   throws ModelException

Gets the java type name.

Returns:

the java name, never null

Throws:

ModelException - if not parsed

getInnerType

public String getInnerType()
                    throws ModelException

Gets the inner type name.

Returns:

the inner type, null if regular type

Throws:

ModelException - if not parsed

getSize

public Integer getSize()
                throws ModelException

Gets the size.

Returns:

the size, null if not set

Throws:

ModelException - if not parsed

getScale

public Integer getScale()
                 throws ModelException

Gets the numeric scale.

Returns:

the scale, null if not set

Throws:

ModelException - if not parsed

getJavaName

public String getJavaName()
                   throws ModelException

Gets the Java attribute name.

Returns:

the java name

Throws:

ModelException - if not parsed

getColumnName

public String getColumnName()
                     throws ModelException

Gets the column name in database table.

Returns:

the column name

Throws:

ModelException - if not parsed

getComment

public String getComment()
                  throws ModelException

Gets the comment.

Returns:

the comment, never null

Throws:

ModelException - if not parsed

getOptions

public List<String> getOptions()
                        throws ModelException

Gets the options.

Returns:

the options (never null)

Throws:

ModelException - if not parsed