Table (JPortal2 1.5.2 API)

java.lang.Object
- bbd.jportal2.Table

All Implemented Interfaces:

Serializable
```
public class Table
extends Object
implements Serializable
```
Table identified by name holds fields, keys, links, grants, views and procedures associated with the table.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`String`	`alias`
`Vector<String>`	`allUsers`
`String`	`check`
`Vector<String>`	`comments`
`Vector<Const>`	`consts`
`Database`	`database`
`Vector<Field>`	`fields`
`Vector<Grant>`	`grants`
`boolean`	`hasAutoTimeStamp`
`boolean`	`hasBigXML`
`boolean`	`hasDelete`
`boolean`	`hasExecute`
`boolean`	`hasIdentity`
`boolean`	`hasInsert`
`boolean`	`hasPrimaryKey`
`boolean`	`hasSelect`
`boolean`	`hasSequence`
`boolean`	`hasSequenceReturning`
`boolean`	`hasStdProcs`
`boolean`	`hasTimeStamp`
`boolean`	`hasUpdate`
`boolean`	`hasUserStamp`
`boolean`	`isLiteral`
`boolean`	`isStoredProc`
`Vector<Key>`	`keys`
`Vector<Link>`	`links`
`String`	`literalName`
`String`	`name`
`Vector<String>`	`options`
`Vector<Parameter>`	`parameters`
`Vector<Proc>`	`procs`
`int`	`start`
`Vector<View>`	`views`

Constructor Summary

Constructors
Constructor and Description

Table()

Constructors
Constructor and Description
`Table()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Table`	`add(Table addin)`
`void`	`buildBulkInsert(Proc proc)` Builds an insert proc generated as part of standard record class
`void`	`buildBulkUpdate(Proc proc)` Builds an update proc generated as part of standard record class
`void`	`buildCount(Proc proc)` Builds a count rows proc
`void`	`buildDeleteAll(Proc proc)` Builds a delete all rows proc
`void`	`buildDeleteBy(Proc proc)`
`void`	`buildDeleteOne(Proc proc)` Builds a delete by primary key proc
`void`	`buildExists(Proc proc)` Builds a check for primary key existance proc
`void`	`buildIdentity(Proc proc)` Builds an identity proc generated as part of standard record class
`void`	`buildInsert(Proc proc)` Builds an insert proc generated as part of standard record class
`void`	`buildMaxTmStamp(Proc proc)` Builds a select on primary key proc
`void`	`buildMerge(Proc proc)` Builds a merge proc generated as part of standard record class
`void`	`buildSelectAll(Proc proc, boolean update, boolean readonly, boolean inOrder, boolean descending)` Builds a select all rows proc
`void`	`buildSelectBy(Proc proc, boolean forUpdate, boolean forReadOnly, boolean inOrder, boolean descending)`
`void`	`buildSelectFrom(Proc proc, Table table)`
`void`	`buildSelectOne(Proc proc, boolean update, boolean readonly)` Builds a select on primary key proc
`void`	`buildUpdate(Proc proc)` Builds an update proc generated as part of standard record class
`void`	`buildUpdateBy(Proc proc)` Builds an updateby proc generated as part of standard record class
`void`	`buildUpdateFor(Proc proc)` Builds an update proc generated as part of standard record class
`String`	`getAlias()`
`Vector<String>`	`getAllUsers()`
`String`	`getCheck()`
`Vector<String>`	`getComments()`
`Vector<Const>`	`getConsts()`
`Database`	`getDatabase()`
`Field`	`getField(String s)`
`Field`	`getFieldForLink(Link link)`
`int`	`getFieldIndex(String s)`
`Vector<Field>`	`getFields()`
`Vector<Grant>`	`getGrants()`
`Vector<Key>`	`getKeys()`
`Link`	`getLinkForField(Field field)`
`Vector<Link>`	`getLinks()`
`String`	`getLiteralName()`
`String`	`getName()`
`Vector<String>`	`getOptions()`
`Vector<Parameter>`	`getParameters()`
`Proc`	`getProc(String name)` Returns proc or null
`Vector<Proc>`	`getProcs()`
`Vector<View>`	`getViews()`
`boolean`	`hasCursorStdProc()` Checks for the existence of a proc
`boolean`	`hasField(String s)` Checks for the existence of a field
`boolean`	`hasFieldAsNull(String s)` Checks if table field is declared as null
`boolean`	`hasOption(String value)`
`boolean`	`hasProc(Proc p)` Checks for the existence of a proc
`boolean`	`isHasAutoTimeStamp()`
`boolean`	`isHasBigXML()`
`boolean`	`isHasDelete()`
`boolean`	`isHasExecute()`
`boolean`	`isHasIdentity()`
`boolean`	`isHasInsert()`
`boolean`	`isHasPrimaryKey()`
`boolean`	`isHasSelect()`
`boolean`	`isHasSequence()`
`boolean`	`isHasSequenceReturning()`
`boolean`	`isHasStdProcs()`
`boolean`	`isHasTimeStamp()`
`boolean`	`isHasUpdate()`
`boolean`	`isHasUserStamp()`
`boolean`	`isLiteral()`
`boolean`	`isStoredProc()`
`void`	`reader(DataInputStream ids)`
`void`	`reader(DataInputStream ids, Vector<?> useProcs)`
`void`	`setPrimary(String s)` Sets a field to be primary key
`String`	`tableName()`
`String`	`toString()`
`String`	`useLiteral()` If there is an literal uses that else returns name
`String`	`useName()` If there is an alias uses that else returns name
`void`	`writer(DataOutputStream ods)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

database
```
public Database database
```

literalName
```
public String literalName
```

name
```
public String name
```

alias
```
public String alias
```

check
```
public String check
```

fields
```
public Vector<Field> fields
```

keys
```
public Vector<Key> keys
```

links
```
public Vector<Link> links
```

grants
```
public Vector<Grant> grants
```

views
```
public Vector<View> views
```

procs
```
public Vector<Proc> procs
```

comments
```
public Vector<String> comments
```

options
```
public Vector<String> options
```

allUsers
```
public Vector<String> allUsers
```

parameters
```
public Vector<Parameter> parameters
```

consts
```
public Vector<Const> consts
```

hasPrimaryKey
```
public boolean hasPrimaryKey
```

hasSequence
```
public boolean hasSequence
```

hasTimeStamp
```
public boolean hasTimeStamp
```

hasAutoTimeStamp
```
public boolean hasAutoTimeStamp
```

hasUserStamp
```
public boolean hasUserStamp
```

hasExecute
```
public boolean hasExecute
```

hasSelect
```
public boolean hasSelect
```

hasInsert
```
public boolean hasInsert
```

hasDelete
```
public boolean hasDelete
```

hasUpdate
```
public boolean hasUpdate
```

hasStdProcs
```
public boolean hasStdProcs
```

hasIdentity
```
public boolean hasIdentity
```

hasSequenceReturning
```
public boolean hasSequenceReturning
```

hasBigXML
```
public boolean hasBigXML
```

isStoredProc
```
public boolean isStoredProc
```

isLiteral
```
public boolean isLiteral
```

start
```
public int start
```

Constructor Detail
- Table
```
public Table()
```

Method Detail

getDatabase
```
public Database getDatabase()
```

getLiteralName
```
public String getLiteralName()
```

getName
```
public String getName()
```

getAlias
```
public String getAlias()
```

getCheck
```
public String getCheck()
```

getFields
```
public Vector<Field> getFields()
```

getLinkForField

public Link getLinkForField(Field field)

getFieldForLink

public Field getFieldForLink(Link link)

getKeys
```
public Vector<Key> getKeys()
```

getLinks
```
public Vector<Link> getLinks()
```

getGrants
```
public Vector<Grant> getGrants()
```

getViews
```
public Vector<View> getViews()
```

getProcs
```
public Vector<Proc> getProcs()
```

getComments
```
public Vector<String> getComments()
```

getOptions
```
public Vector<String> getOptions()
```

getAllUsers
```
public Vector<String> getAllUsers()
```

getParameters

public Vector<Parameter> getParameters()

getConsts
```
public Vector<Const> getConsts()
```

isHasPrimaryKey
```
public boolean isHasPrimaryKey()
```

isHasSequence
```
public boolean isHasSequence()
```

isHasTimeStamp
```
public boolean isHasTimeStamp()
```

isHasAutoTimeStamp
```
public boolean isHasAutoTimeStamp()
```

isHasUserStamp
```
public boolean isHasUserStamp()
```

isHasExecute
```
public boolean isHasExecute()
```

isHasSelect
```
public boolean isHasSelect()
```

isHasInsert
```
public boolean isHasInsert()
```

isHasDelete
```
public boolean isHasDelete()
```

isHasUpdate
```
public boolean isHasUpdate()
```

isHasStdProcs
```
public boolean isHasStdProcs()
```

isHasIdentity
```
public boolean isHasIdentity()
```

isHasSequenceReturning

public boolean isHasSequenceReturning()

isHasBigXML
```
public boolean isHasBigXML()
```

isStoredProc
```
public boolean isStoredProc()
```

isLiteral
```
public boolean isLiteral()
```

reader

public void reader(DataInputStream ids)
            throws IOException

Throws:: IOException

reader

public void reader(DataInputStream ids,
                   Vector<?> useProcs)
            throws IOException

Throws:: IOException

writer

public void writer(DataOutputStream ods)
            throws IOException

Throws:: IOException

useLiteral
```
public String useLiteral()
```
If there is an literal uses that else returns name

useName
```
public String useName()
```
If there is an alias uses that else returns name

hasField
```
public boolean hasField(String s)
```
Checks for the existence of a field

getField
```
public Field getField(String s)
```

getFieldIndex
```
public int getFieldIndex(String s)
```

hasFieldAsNull
```
public boolean hasFieldAsNull(String s)
```
Checks if table field is declared as null

hasProc
```
public boolean hasProc(Proc p)
```
Checks for the existence of a proc

getProc
```
public Proc getProc(String name)
```
Returns proc or null

hasCursorStdProc
```
public boolean hasCursorStdProc()
```
Checks for the existence of a proc

setPrimary
```
public void setPrimary(String s)
```
Sets a field to be primary key

tableName
```
public String tableName()
```

buildMerge
```
public void buildMerge(Proc proc)
```
Builds a merge proc generated as part of standard record class

buildInsert
```
public void buildInsert(Proc proc)
```
Builds an insert proc generated as part of standard record class

buildBulkInsert
```
public void buildBulkInsert(Proc proc)
```
Builds an insert proc generated as part of standard record class

buildIdentity
```
public void buildIdentity(Proc proc)
```
Builds an identity proc generated as part of standard record class

buildUpdate
```
public void buildUpdate(Proc proc)
```
Builds an update proc generated as part of standard record class

buildUpdateFor
```
public void buildUpdateFor(Proc proc)
```
Builds an update proc generated as part of standard record class

buildUpdateBy
```
public void buildUpdateBy(Proc proc)
```
Builds an updateby proc generated as part of standard record class

buildBulkUpdate
```
public void buildBulkUpdate(Proc proc)
```
Builds an update proc generated as part of standard record class

buildDeleteOne
```
public void buildDeleteOne(Proc proc)
```
Builds a delete by primary key proc

buildDeleteAll
```
public void buildDeleteAll(Proc proc)
```
Builds a delete all rows proc

buildCount
```
public void buildCount(Proc proc)
```
Builds a count rows proc

buildExists
```
public void buildExists(Proc proc)
```
Builds a check for primary key existance proc

buildSelectOne

public void buildSelectOne(Proc proc,
                           boolean update,
                           boolean readonly)

Builds a select on primary key proc

buildMaxTmStamp
```
public void buildMaxTmStamp(Proc proc)
```
Builds a select on primary key proc

buildSelectAll

public void buildSelectAll(Proc proc,
                           boolean update,
                           boolean readonly,
                           boolean inOrder,
                           boolean descending)

Builds a select all rows proc

buildDeleteBy
```
public void buildDeleteBy(Proc proc)
```

buildSelectBy

public void buildSelectBy(Proc proc,
                          boolean forUpdate,
                          boolean forReadOnly,
                          boolean inOrder,
                          boolean descending)

buildSelectFrom

public void buildSelectFrom(Proc proc,
                            Table table)

toString
```
public String toString()
```
Overrides:

toString in class Object

add
```
public Table add(Table addin)
```

hasOption

public boolean hasOption(String value)

Class Table

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

database

literalName

name

alias

check

fields

keys

links

grants

views

procs

comments

options

allUsers

parameters

consts

hasPrimaryKey

hasSequence

hasTimeStamp

hasAutoTimeStamp

hasUserStamp

hasExecute

hasSelect

hasInsert

hasDelete

hasUpdate

hasStdProcs

hasIdentity

hasSequenceReturning

hasBigXML

isStoredProc

isLiteral

start

Constructor Detail

Table

Method Detail

getDatabase

getLiteralName

getName

getAlias

getCheck

getFields

getLinkForField

getFieldForLink

getKeys

getLinks

getGrants

getViews

getProcs

getComments

getOptions

getAllUsers

getParameters

getConsts

isHasPrimaryKey

isHasSequence

isHasTimeStamp

isHasAutoTimeStamp

isHasUserStamp

isHasExecute

isHasSelect

isHasInsert

isHasDelete

isHasUpdate

isHasStdProcs

isHasIdentity

isHasSequenceReturning

isHasBigXML

isStoredProc

isLiteral

reader

reader

writer

useLiteral