xcodegen.structure
Class XClass

java.lang.Object
  |
  +--xcodegen.structure.AbstractXObject
        |
        +--xcodegen.structure.XClass

public class XClass
extends AbstractXObject

Class descriptor

Version:
$Revision: 1.1.1.1 $
Author:
Herve

Field Summary
static java.lang.String INHERITED_PK_COLUMN
           
 
Constructor Summary
XClass()
           
 
Method Summary
 boolean addField(XField field)
           
 boolean addFinder(XFinder finder)
           
 java.lang.String getAuthor()
           
 XField getField(java.lang.String name)
          Get a field by its name
 java.util.Collection getFields()
           
 java.util.Collection getFields(boolean superfields)
          Return the fields of the class
protected  java.lang.String getFieldsAsCSV()
          Return the list of field as ComaSeparatedValued in the format
 XFinder getFinder(java.lang.String name)
          Get a finder by its name
 java.util.Collection getFinders()
           
 XField getPk()
           
 java.lang.String getPkColumn()
          Return the name of the PrimaryKey column.
 java.lang.String getSQLDelete()
          Return the DELETE SQL statement
 java.lang.String getSQLInsert()
          Return the INSERT SQL statement
 java.lang.String getSQLSelect()
          Return the SELECT SQL statement
 java.lang.String getSQLUpdate()
          Return the UPDATE SQL statement
 XClass getSuperclass()
           
 XField getSuperPk()
          Return the super PrimaryKey.
 java.lang.String getTable()
           
 java.lang.String getVersion()
           
 void setAuthor(java.lang.String author)
           
 void setPk(XField pk)
           
 void setSuperclass(XClass superclass)
           
 void setTable(java.lang.String table)
           
 void setVersion(java.lang.String version)
           
 
Methods inherited from class xcodegen.structure.AbstractXObject
add, getBeanName, getChild, getChild, getChildren, getChildren, getDescription, getName, getParent, hasChild, setDescription, setName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

INHERITED_PK_COLUMN

public static final java.lang.String INHERITED_PK_COLUMN
See Also:
Constant Field Values
Constructor Detail

XClass

public XClass()
Method Detail

getTable

public java.lang.String getTable()

setTable

public void setTable(java.lang.String table)

getAuthor

public java.lang.String getAuthor()

setAuthor

public void setAuthor(java.lang.String author)

getVersion

public java.lang.String getVersion()

setVersion

public void setVersion(java.lang.String version)

getPk

public XField getPk()

setPk

public void setPk(XField pk)

getSuperclass

public XClass getSuperclass()

setSuperclass

public void setSuperclass(XClass superclass)

getFields

public java.util.Collection getFields()

addField

public boolean addField(XField field)

getFinders

public java.util.Collection getFinders()

addFinder

public boolean addFinder(XFinder finder)

getSuperPk

public XField getSuperPk()
Return the super PrimaryKey.

Returns:
super PK

getPkColumn

public java.lang.String getPkColumn()
Return the name of the PrimaryKey column. If the class hasa superclass, the primary key column is defined by INHERITED_PK_COLUMN

Returns:
name of the PrimaryKey column
See Also:
INHERITED_PK_COLUMN

getField

public XField getField(java.lang.String name)
Get a field by its name

Parameters:
name - name of the field requested
Returns:
field requested

getFields

public java.util.Collection getFields(boolean superfields)
Return the fields of the class

Parameters:
superfields - include fields of the super class?
Returns:
fields

getFinder

public XFinder getFinder(java.lang.String name)
Get a finder by its name

Parameters:
name - name of the field requested
Returns:
field requested

getSQLDelete

public java.lang.String getSQLDelete()
Return the DELETE SQL statement

Returns:
DELETE SQL statement

getSQLInsert

public java.lang.String getSQLInsert()
Return the INSERT SQL statement

Returns:
INSERT SQL statement

getSQLUpdate

public java.lang.String getSQLUpdate()
Return the UPDATE SQL statement

Returns:
UPDATE SQL statement

getSQLSelect

public java.lang.String getSQLSelect()
Return the SELECT SQL statement

Returns:
SELECT SQL statement

getFieldsAsCSV

protected java.lang.String getFieldsAsCSV()
Return the list of field as ComaSeparatedValued in the format

Returns:
fields as CSV