Proc (JPortal2 1.2.0 API)

java.lang.Object
- bbd.jportal2.Proc

All Implemented Interfaces:

Serializable
```
public class Proc
extends Object
implements Serializable
```
The hearts and souls. Holds the procedures for accessing the table.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`Vector<String>`	`comments` The reasons and debates for the procedure
`Vector<String>`	`dynamics` List of dynamic SQL code fields
`Vector<Integer>`	`dynamicSizes` List of dynamic SQL code field sizes
`Vector<Boolean>`	`dynamicStrung` List of dynamic SQL code field sizes
`boolean`	`extendsStd` Indicates the procedures extends the Standard Table definition
`Vector<String>`	`fields` SelectBy DeleteBy std proc fields
`String`	`from` name of procedure
`boolean`	`hasImage` Indicates the procedure has an Image field
`boolean`	`hasReturning`
`boolean`	`hasUpdates`
`Vector<Field>`	`inputs` List of input fields
`boolean`	`isAction` Indicates an action no result is expected
`boolean`	`isData` If the procedure is only to produce passthru SQL Code
`boolean`	`isIdlCode` If the procedure is only to produce passthru SQL Code
`boolean`	`isInsert` Indicates the procedure is the Insert procedure
`boolean`	`isMultipleInput` Indicates a single result is expected
`boolean`	`isProc` Indicates the procedure uses stored procedure logic Code
`boolean`	`isSingle` Indicates a single result is expected
`boolean`	`isSProc` Indicates the procedure uses stored procedure logic Code
`boolean`	`isSql` Indicates the procedure is internal SQL code
`boolean`	`isStd` Indicates procedure is a Standard procedure
`boolean`	`isUpdate` Indicates a update Proc
`Vector<Line>`	`lines` SQL code for accessing the table
`String`	`name` name of procedure
`int`	`noRows` name of rows on multiples
`Vector<String>`	`options` Generate options for procedure
`Vector<String>`	`orderFields` Select in order fields
`Vector<Field>`	`outputs` List of output fields
`Vector<String>`	`placeHolders` SQL code for accessing the table
`int`	`start` Code starts at line
`Table`	`table` parent table
`Vector<String>`	`updateFields` SelectFor update fields
`boolean`	`useKey` Indicates the procedures uses the Primary key
`String`	`username` user name of procedure
`boolean`	`useStd` Indicates the procedure uses the Standard Table definition
`String`	`where` name of procedure

Constructor Summary

Constructors
Constructor and Description

Proc()
Constructs with default values

Constructors
Constructor and Description
`Proc()` Constructs with default values

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`checkPlaceHolders()`
`Vector<String>`	`getComments()`
`Vector<String>`	`getDynamics()`
`int`	`getDynamicSize(String s)` Checks for for name in dynamics list
`Vector<Integer>`	`getDynamicSizes()`
`Vector<Boolean>`	`getDynamicStrung()`
`Vector<String>`	`getFields()`
`String`	`getFrom()`
`Field`	`getInput(String s)`
`Vector<Field>`	`getInputs()`
`Vector<Line>`	`getLines()`
`String`	`getName()`
`int`	`getNoRows()`
`Vector<String>`	`getOptions()`
`Vector<String>`	`getOrderFields()`
`Field`	`getOutput(String s)` Checks for for name in output list
`Vector<Field>`	`getOutputs()`
`Vector<String>`	`getPlaceHolders()`
`Vector<String>`	`getUpdateFields()`
`String`	`getUsername()`
`String`	`getWhere()`
`boolean`	`hasDiscreteInput()` Checks if proc has unique input ie.
`boolean`	`hasDynamic(String s)` Checks for for name in dynamics list
`boolean`	`hasFields(String value)`
`boolean`	`hasInput(String s)` Checks for for name in input list
`boolean`	`hasModifieds()`
`boolean`	`hasNoData()` Checks if proc uses data
`boolean`	`hasOption(String value)`
`boolean`	`hasOrders(String value)`
`boolean`	`hasOutput(String s)` Checks for for name in output list
`boolean`	`hasUpdateFields(String value)`
`int`	`indexOf(String s)` Checks for for name in input list
`boolean`	`isAction()`
`boolean`	`isData()`
`boolean`	`isExtendsStd()`
`boolean`	`isHasImage()`
`boolean`	`isHasReturning()`
`boolean`	`isHasUpdates()`
`boolean`	`isIdlCode()`
`boolean`	`isInsert()`
`boolean`	`isMultipleInput()`
`boolean`	`isProc()`
`boolean`	`isSingle()`
`boolean`	`isSProc()`
`boolean`	`isSql()`
`boolean`	`isStd()`
`boolean`	`isStdExtended()`
`boolean`	`isStrung(String s)` Checks if a strung dynamic
`boolean`	`isUpdate()`
`boolean`	`isUseKey()`
`boolean`	`isUseStd()`
`String`	`lowerFirst()` Folds the first character of name to an lower case character
`void`	`reader(DataInputStream ids)`
`String`	`toString()`
`String`	`upperFirst()` Folds the first character of name to an upper case character
`String`	`upperFirstOnly()` Folds the first character of name to an upper case character
`void`	`writer(DataOutputStream ods)`

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

Field Detail
- table
```
public Table table
```
  parent table
- name
```
public String name
```
  name of procedure
- from
```
public String from
```
  name of procedure
- where
```
public String where
```
  name of procedure
- username
```
public String username
```
  user name of procedure
- noRows
```
public int noRows
```
  name of rows on multiples
- inputs
```
public Vector<Field> inputs
```
  List of input fields
- outputs
```
public Vector<Field> outputs
```
  List of output fields
- dynamics
```
public Vector<String> dynamics
```
  List of dynamic SQL code fields
- dynamicSizes
```
public Vector<Integer> dynamicSizes
```
  List of dynamic SQL code field sizes
- dynamicStrung
```
public Vector<Boolean> dynamicStrung
```
  List of dynamic SQL code field sizes
- placeHolders
```
public Vector<String> placeHolders
```
  SQL code for accessing the table
- lines
```
public Vector<Line> lines
```
  SQL code for accessing the table
- comments
```
public Vector<String> comments
```
  The reasons and debates for the procedure
- options
```
public Vector<String> options
```
  Generate options for procedure
- fields
```
public Vector<String> fields
```
  SelectBy DeleteBy std proc fields
- updateFields
```
public Vector<String> updateFields
```
  SelectFor update fields
- orderFields
```
public Vector<String> orderFields
```
  Select in order fields
- isProc
```
public boolean isProc
```
  Indicates the procedure uses stored procedure logic Code
- isSProc
```
public boolean isSProc
```
  Indicates the procedure uses stored procedure logic Code
- isData
```
public boolean isData
```
  If the procedure is only to produce passthru SQL Code
- isIdlCode
```
public boolean isIdlCode
```
  If the procedure is only to produce passthru SQL Code
- isSql
```
public boolean isSql
```
  Indicates the procedure is internal SQL code
- isSingle
```
public boolean isSingle
```
  Indicates a single result is expected
- isUpdate
```
public boolean isUpdate
```
  Indicates a update Proc
- isAction
```
public boolean isAction
```
  Indicates an action no result is expected
- isStd
```
public boolean isStd
```
  Indicates procedure is a Standard procedure
- useStd
```
public boolean useStd
```
  Indicates the procedure uses the Standard Table definition
- extendsStd
```
public boolean extendsStd
```
  Indicates the procedures extends the Standard Table definition
- useKey
```
public boolean useKey
```
  Indicates the procedures uses the Primary key
- hasImage
```
public boolean hasImage
```
  Indicates the procedure has an Image field
- isMultipleInput
```
public boolean isMultipleInput
```
  Indicates a single result is expected
- isInsert
```
public boolean isInsert
```
  Indicates the procedure is the Insert procedure
- hasReturning
```
public boolean hasReturning
```
- hasUpdates
```
public boolean hasUpdates
```
- start
```
public int start
```
  Code starts at line

Constructor Detail
- Proc
```
public Proc()
```
  Constructs with default values

Method Detail

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

getFrom
```
public String getFrom()
```

getWhere
```
public String getWhere()
```

getUsername
```
public String getUsername()
```

getNoRows
```
public int getNoRows()
```

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

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

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

getDynamicSizes

public Vector<Integer> getDynamicSizes()

getDynamicStrung

public Vector<Boolean> getDynamicStrung()

getPlaceHolders

public Vector<String> getPlaceHolders()

getLines
```
public Vector<Line> getLines()
```

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

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

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

getUpdateFields

public Vector<String> getUpdateFields()

getOrderFields

public Vector<String> getOrderFields()

isProc
```
public boolean isProc()
```

isSProc
```
public boolean isSProc()
```

isData
```
public boolean isData()
```

isIdlCode
```
public boolean isIdlCode()
```

isSql
```
public boolean isSql()
```

isSingle
```
public boolean isSingle()
```

isUpdate
```
public boolean isUpdate()
```

isAction
```
public boolean isAction()
```

isStd
```
public boolean isStd()
```

isUseStd
```
public boolean isUseStd()
```

isExtendsStd
```
public boolean isExtendsStd()
```

isUseKey
```
public boolean isUseKey()
```

isHasImage
```
public boolean isHasImage()
```

isMultipleInput
```
public boolean isMultipleInput()
```

isInsert
```
public boolean isInsert()
```

isHasReturning
```
public boolean isHasReturning()
```

isHasUpdates
```
public boolean isHasUpdates()
```

reader

public void reader(DataInputStream ids)
            throws IOException

Throws:: IOException

writer

public void writer(DataOutputStream ods)
            throws IOException

Throws:: IOException

upperFirst
```
public String upperFirst()
```
Folds the first character of name to an upper case character

upperFirstOnly
```
public String upperFirstOnly()
```
Folds the first character of name to an upper case character

lowerFirst
```
public String lowerFirst()
```
Folds the first character of name to an lower case character

hasInput
```
public boolean hasInput(String s)
```
Checks for for name in input list

getInput
```
public Field getInput(String s)
```

hasModifieds
```
public boolean hasModifieds()
```

indexOf
```
public int indexOf(String s)
```
Checks for for name in input list

hasOutput
```
public boolean hasOutput(String s)
```
Checks for for name in output list

getOutput
```
public Field getOutput(String s)
```
Checks for for name in output list

hasDynamic
```
public boolean hasDynamic(String s)
```
Checks for for name in dynamics list

getDynamicSize
```
public int getDynamicSize(String s)
```
Checks for for name in dynamics list

isStrung
```
public boolean isStrung(String s)
```
Checks if a strung dynamic

hasNoData
```
public boolean hasNoData()
```
Checks if proc uses data

hasDiscreteInput
```
public boolean hasDiscreteInput()
```
Checks if proc has unique input ie. not already in output

checkPlaceHolders
```
public void checkPlaceHolders()
```

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

toString in class Object

hasOption

public boolean hasOption(String value)

hasFields

public boolean hasFields(String value)

hasOrders

public boolean hasOrders(String value)

hasUpdateFields

public boolean hasUpdateFields(String value)

isStdExtended
```
public boolean isStdExtended()
```

Class Proc

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

table

name

from

where

username

noRows

inputs

outputs

dynamics

dynamicSizes

dynamicStrung

placeHolders

lines

comments

options

fields

updateFields

orderFields

isProc

isSProc

isData

isIdlCode

isSql

isSingle

isUpdate

isAction

isStd

useStd

extendsStd

useKey

hasImage

isMultipleInput

isInsert

hasReturning

hasUpdates

start

Constructor Detail

Proc

Method Detail

getName

getFrom

getWhere

getUsername

getNoRows

getInputs

getOutputs

getDynamics

getDynamicSizes

getDynamicStrung

getPlaceHolders

getLines

getComments

getOptions

getFields

getUpdateFields

getOrderFields

isProc

isSProc

isData

isIdlCode

isSql

isSingle

isUpdate

isAction

isStd

isUseStd

isExtendsStd

isUseKey

isHasImage

isMultipleInput

isInsert

isHasReturning

isHasUpdates

reader