DBMetaData (OA Java Code Documentation)

java.lang.Object
- com.viaoa.object.OAObject
- - com.viaoa.ds.jdbc.db.DBMetaData

All Implemented Interfaces:

Serializable, Comparable
```
@OAClass(useDataSource=false,
         localOnly=false)
public class DBMetaData
extends OAObject
```
Database MetaData for various JDBC databases.

Author:

vvia see for data types: http://docs.oracle.com/javase/1.5.0/docs/guide/jdbc/getstart/mapping.html#table1

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ACCESS`
`boolean`	`allowStatementPooling`
`String`	`autoAssignValue`
`boolean`	`blanksAsNulls`
`boolean`	`booleanKeyword`
`static int`	`BRIDGE`
`boolean`	`caseSensitive`
`int`	`databaseType`
`boolean`	`datesIncludeTime`
`static int`	`DERBY`
`String`	`description`
`String`	`distinctKeyword`
`String`	`driverJDBC`
`boolean`	`fkeysAutoCreateIndex`
`String`	`guid`
`String`	`leftBracket`
`String`	`lowerCaseFunction`
`int`	`maxConnections`
`String`	`maxString`
`int`	`maxVarcharLength`
`int`	`minConnections`
`static int`	`MYSQL`
`String`	`name`
`String`	`note`
`protected static OAObjectInfo`	`oaObjectInfo`
`Object`	`objectFalse`
`Object`	`objectTrue`
`static int`	`ORACLE`
`static int`	`OTHER`
`String`	`outerjoinEnd`
`String`	`outerjoinStart`
`String`	`password`
`String`	`rightBracket`
`static int`	`SQLSERVER`
`boolean`	`supportsAutoAssign`
`String`	`urlJDBC`
`boolean`	`useBackslashForEscape`
`boolean`	`useBracket`
`boolean`	`useExists`
`boolean`	`useOuterJoinEscape`
`String`	`user`

Fields inherited from class com.viaoa.object.OAObject
CASCADE_ALL_LINKS, CASCADE_LINK_RULES, CASCADE_NONE, CASCADE_OWNED_LINKS, changedFlag, cntFinal, cntNew, deletedFlag, newFlag, nulls, OALOG, objectKey, properties, weakhubs

Constructor Summary

Constructors
Constructor and Description
`DBMetaData()`
`DBMetaData(int databaseType)`
`DBMetaData(int databaseType, String user, String password, String driverJDBC, String urlJDBC)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`getAllowStatementPooling()`
`String`	`getAutoAssignValue()`
`boolean`	`getBlanksAsNulls()`
`boolean`	`getBooleanKeyword()`
`boolean`	`getCaseSensitive()`
`int`	`getDatabaseType()`
`boolean`	`getDatesIncludeTime()`
`String`	`getDescription()`
`String`	`getDistinctKeyword()`
`String`	`getDriverJDBC()`
`boolean`	`getFkeysAutoCreateIndex()`
`String`	`getLeftBracket()`
`String`	`getLowerCaseFunction()`
`int`	`getMaxConnections()`
`String`	`getMaxString()`
`int`	`getMaxVarcharLength()`
`int`	`getMinConnections()`
`String`	`getName()`
`String`	`getNote()`
`static OAObjectInfo`	`getOAObjectInfo()`
`Object`	`getObjectFalse()`
`Object`	`getObjectTrue()`
`String`	`getOuterjoinEnd()`
`String`	`getOuterjoinStart()`
`String`	`getPassword()`
`String`	`getRightBracket()`
`boolean`	`getSupportsAutoAssign()`
`String`	`getUrlJDBC()`
`boolean`	`getUseBackslashForEscape()`
`boolean`	`getUseBracket()`
`boolean`	`getUseExists()`
`boolean`	`getUseOuterJoinEscape()`
`String`	`getUser()`
`void`	`setAllowStatementPooling(boolean b)`
`void`	`setAutoAssignValue(String autoAssignValue)`
`void`	`setBlanksAsNulls(boolean blanksAsNulls)`
`void`	`setBooleanKeyword(boolean booleanKeyword)`
`void`	`setCaseSensitive(boolean caseSensitive)`
`void`	`setDatabaseType(int dbType)`
`void`	`setDatesIncludeTime(boolean bDatesIncludeTime)`
`void`	`setDescription(String description)`
`void`	`setDistinctKeyword(String distinctKeyword)`
`void`	`setDriverJDBC(String driverJDBC)`
`void`	`setFkeysAutoCreateIndex(boolean b)`
`void`	`setLeftBracket(String leftBracket)`
`void`	`setLowerCaseFunction(String lowerCaseFunction)`
`void`	`setMaxConnections(int maxConnections)`
`void`	`setMaxString(String maxString)`
`void`	`setMaxVarcharLength(int x)`
`void`	`setMinConnections(int minConnections)`
`void`	`setName(String name)`
`void`	`setNote(String note)`
`void`	`setObjectFalse(Object objectFalse)`
`void`	`setObjectTrue(Object objectTrue)`
`void`	`setOuterjoinEnd(String outerjoinEnd)`
`void`	`setOuterjoinStart(String outerjoinStart)`
`void`	`setPassword(String password)`
`void`	`setRightBracket(String rightBracket)`
`void`	`setSupportsAutoAssign(boolean supportsAutoAssign)`
`void`	`setUrlJDBC(String urlJDBC)`
`void`	`setUseBackslashForEscape(boolean useBackslashForEscape)`
`void`	`setUseBracket(boolean useBracket)`
`void`	`setUseExists(boolean useExists)`
`void`	`setUseOuterJoinEscape(boolean useOuterJoinEscape)`
`void`	`setUser(String user)`

Methods inherited from class com.viaoa.object.OAObject
afterDelete, afterLoad, afterSave, beginServerOnly, callRemote, canDelete, canSave, compareTo, copyInto, createCopy, createCopy, delete, endServerOnly, equals, finalize, find, findAll, fireBeforePropertyChange, fireBeforePropertyChange, fireBeforePropertyChange, fireBeforePropertyChange, fireBeforePropertyChange, fireBeforePropertyChange, fireLocalPropertyChange, fireLocalPropertyChange, fireLocalPropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAutoAdd, getBlob, getChanged, getChanged, getChanged, getDebugMode, getDeleted, getFinalizeSave, getGuid, getHub, getHub, getHub, getHub, getHub, getHub, getNew, getOAVersion, getObject, getObjectKey, getProperty, getPropertyAsString, getPropertyAsString, getPropertyAsString, getPropertyAsString, getUniqueInstance, hashCode, hierFind, isChanged, isChanged, isClient, isDeleted, isEmpty, isEnabled, isEnabled, isHubLoaded, isLoaded, isLoading, isLocked, isNew, isNull, isPropertyLoaded, isPropertyLocked, isReferenceNull, isReferenceObjectNull, isRemoteAvailable, isRemoteAvailable, isRemoteThread, isServer, isUnique, isValidPropertyChange, isVisible, isVisible, loadReferences, loadReferences, loadReferences, loadReferences, lock, readResolve, remote, removeProperty, save, save, saveAll, sendMessages, sendMessages, setAutoAdd, setChanged, setDebugMode, setDeleted, setFinalizeSave, setHub, setNew, setNull, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, startServerOnly, unlock, verifyCommand, wasDeleted

Methods inherited from class java.lang.Object
clone, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

OTHER
```
public static final int OTHER
```
See Also:

Constant Field Values

DERBY
```
public static final int DERBY
```
See Also:

Constant Field Values

SQLSERVER
```
public static final int SQLSERVER
```
See Also:

Constant Field Values

ORACLE
```
public static final int ORACLE
```
See Also:

Constant Field Values

ACCESS
```
public static final int ACCESS
```
See Also:

Constant Field Values

MYSQL
```
public static final int MYSQL
```
See Also:

Constant Field Values

BRIDGE
```
public static final int BRIDGE
```
See Also:

Constant Field Values

databaseType
```
public int databaseType
```

note
```
public String note
```

name
```
public String name
```

description
```
public String description
```

useBracket
```
public boolean useBracket
```

leftBracket
```
public String leftBracket
```

rightBracket
```
public String rightBracket
```

distinctKeyword
```
public String distinctKeyword
```

blanksAsNulls
```
public boolean blanksAsNulls
```

useOuterJoinEscape
```
public boolean useOuterJoinEscape
```

outerjoinStart
```
public String outerjoinStart
```

outerjoinEnd
```
public String outerjoinEnd
```

objectTrue
```
public Object objectTrue
```

objectFalse
```
public Object objectFalse
```

booleanKeyword
```
public boolean booleanKeyword
```

datesIncludeTime
```
public boolean datesIncludeTime
```

useExists
```
public boolean useExists
```

useBackslashForEscape
```
public boolean useBackslashForEscape
```

caseSensitive
```
public boolean caseSensitive
```

lowerCaseFunction
```
public String lowerCaseFunction
```

supportsAutoAssign
```
public boolean supportsAutoAssign
```

autoAssignValue
```
public String autoAssignValue
```

maxString
```
public String maxString
```

guid
```
public String guid
```

allowStatementPooling
```
public boolean allowStatementPooling
```

fkeysAutoCreateIndex
```
public boolean fkeysAutoCreateIndex
```

maxVarcharLength
```
public int maxVarcharLength
```

driverJDBC
```
public String driverJDBC
```

urlJDBC
```
public String urlJDBC
```

user
```
public String user
```

password
```
public String password
```

maxConnections
```
public int maxConnections
```

minConnections
```
public int minConnections
```

oaObjectInfo

protected static OAObjectInfo oaObjectInfo

Constructor Detail

DBMetaData
```
public DBMetaData()
```

DBMetaData
```
public DBMetaData(int databaseType)
```

DBMetaData

public DBMetaData(int databaseType,
                  String user,
                  String password,
                  String driverJDBC,
                  String urlJDBC)

Method Detail

setDatabaseType

public void setDatabaseType(int dbType)

getDatabaseType
```
public int getDatabaseType()
```

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

setName
```
public void setName(String name)
```

getNote
```
public String getNote()
```

setNote
```
public void setNote(String note)
```

getDescription
```
public String getDescription()
```

setDescription

public void setDescription(String description)

getFkeysAutoCreateIndex

public boolean getFkeysAutoCreateIndex()

setFkeysAutoCreateIndex

public void setFkeysAutoCreateIndex(boolean b)

getAllowStatementPooling

public boolean getAllowStatementPooling()

setAllowStatementPooling

public void setAllowStatementPooling(boolean b)

getUseBracket
```
public boolean getUseBracket()
```

setUseBracket

public void setUseBracket(boolean useBracket)

getLeftBracket
```
public String getLeftBracket()
```

setLeftBracket

public void setLeftBracket(String leftBracket)

getRightBracket
```
public String getRightBracket()
```

setRightBracket

public void setRightBracket(String rightBracket)

getDistinctKeyword
```
public String getDistinctKeyword()
```

setDistinctKeyword

public void setDistinctKeyword(String distinctKeyword)

getBlanksAsNulls
```
public boolean getBlanksAsNulls()
```

setBlanksAsNulls

public void setBlanksAsNulls(boolean blanksAsNulls)

getUseOuterJoinEscape

public boolean getUseOuterJoinEscape()

setUseOuterJoinEscape

public void setUseOuterJoinEscape(boolean useOuterJoinEscape)

getOuterjoinStart
```
public String getOuterjoinStart()
```

setOuterjoinStart

public void setOuterjoinStart(String outerjoinStart)

getOuterjoinEnd
```
public String getOuterjoinEnd()
```

setOuterjoinEnd

public void setOuterjoinEnd(String outerjoinEnd)

getObjectTrue
```
public Object getObjectTrue()
```

setObjectTrue

public void setObjectTrue(Object objectTrue)

getObjectFalse
```
public Object getObjectFalse()
```

setObjectFalse

public void setObjectFalse(Object objectFalse)

getBooleanKeyword
```
public boolean getBooleanKeyword()
```

setBooleanKeyword

public void setBooleanKeyword(boolean booleanKeyword)

getDatesIncludeTime
```
public boolean getDatesIncludeTime()
```

setDatesIncludeTime

public void setDatesIncludeTime(boolean bDatesIncludeTime)

getUseExists
```
public boolean getUseExists()
```

setUseExists

public void setUseExists(boolean useExists)

getUseBackslashForEscape

public boolean getUseBackslashForEscape()

setUseBackslashForEscape

public void setUseBackslashForEscape(boolean useBackslashForEscape)

getCaseSensitive
```
public boolean getCaseSensitive()
```

setCaseSensitive

public void setCaseSensitive(boolean caseSensitive)

getLowerCaseFunction
```
public String getLowerCaseFunction()
```

setLowerCaseFunction

public void setLowerCaseFunction(String lowerCaseFunction)

getSupportsAutoAssign

public boolean getSupportsAutoAssign()

setSupportsAutoAssign

public void setSupportsAutoAssign(boolean supportsAutoAssign)

getAutoAssignValue
```
public String getAutoAssignValue()
```

setAutoAssignValue

public void setAutoAssignValue(String autoAssignValue)

getMaxString
```
public String getMaxString()
```

setMaxString

public void setMaxString(String maxString)

getDriverJDBC
```
public String getDriverJDBC()
```

setDriverJDBC

public void setDriverJDBC(String driverJDBC)

getUrlJDBC
```
public String getUrlJDBC()
```

setUrlJDBC

public void setUrlJDBC(String urlJDBC)

getUser
```
public String getUser()
```

setUser
```
public void setUser(String user)
```

getPassword
```
public String getPassword()
```

setPassword

public void setPassword(String password)

getMaxConnections
```
public int getMaxConnections()
```

setMaxConnections

public void setMaxConnections(int maxConnections)

getMinConnections
```
public int getMinConnections()
```

setMinConnections

public void setMinConnections(int minConnections)

getOAObjectInfo

public static OAObjectInfo getOAObjectInfo()

getMaxVarcharLength
```
public int getMaxVarcharLength()
```

setMaxVarcharLength

public void setMaxVarcharLength(int x)

Class DBMetaData

Field Summary

Fields inherited from class com.viaoa.object.OAObject

Constructor Summary

Method Summary

Methods inherited from class com.viaoa.object.OAObject

Methods inherited from class java.lang.Object

Field Detail

OTHER

DERBY

SQLSERVER

ORACLE

ACCESS

MYSQL

BRIDGE

databaseType

note

name

description

useBracket

leftBracket

rightBracket

distinctKeyword

blanksAsNulls

useOuterJoinEscape

outerjoinStart

outerjoinEnd

objectTrue

objectFalse

booleanKeyword

datesIncludeTime

useExists

useBackslashForEscape

caseSensitive

lowerCaseFunction

supportsAutoAssign

autoAssignValue

maxString

guid

allowStatementPooling

fkeysAutoCreateIndex

maxVarcharLength

driverJDBC

urlJDBC

user

password

maxConnections

minConnections

oaObjectInfo

Constructor Detail

DBMetaData

DBMetaData

DBMetaData

Method Detail

setDatabaseType

getDatabaseType

getName

setName

getNote

setNote

getDescription

setDescription

getFkeysAutoCreateIndex

setFkeysAutoCreateIndex

getAllowStatementPooling

setAllowStatementPooling

getUseBracket

setUseBracket

getLeftBracket

setLeftBracket

getRightBracket

setRightBracket

getDistinctKeyword

setDistinctKeyword

getBlanksAsNulls

setBlanksAsNulls

getUseOuterJoinEscape

setUseOuterJoinEscape

getOuterjoinStart

setOuterjoinStart