ColumnDescription

java.lang.Object
- org.apache.manifoldcf.core.interfaces.ColumnDescription

public class ColumnDescription
extends java.lang.Object

Describe a database column.

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`_rcsid`
`protected boolean`	`isNull`
`protected boolean`	`isPrimaryKey`
`protected boolean`	`referenceCascade`
`protected java.lang.String`	`referenceColumn`
`protected java.lang.String`	`referenceTable`
`protected java.lang.String`	`typeString`

Constructor Summary

Constructors
Constructor	Description
`ColumnDescription(java.lang.String typeString, boolean isPrimaryKey, boolean isNull, java.lang.String referenceTable, java.lang.String referenceColumn, boolean referenceCascade)`	Create a column type description.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`getIsNull()`
`boolean`	`getIsPrimaryKey()`
`boolean`	`getReferenceCascade()`
`java.lang.String`	`getReferenceColumn()`
`java.lang.String`	`getReferenceTable()`
`java.lang.String`	`getTypeString()`

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

Field Detail

_rcsid

public static final java.lang.String _rcsid

See Also:: Constant Field Values

typeString
```
protected java.lang.String typeString
```

isPrimaryKey
```
protected boolean isPrimaryKey
```

isNull
```
protected boolean isNull
```

referenceTable

protected java.lang.String referenceTable

referenceColumn

protected java.lang.String referenceColumn

referenceCascade
```
protected boolean referenceCascade
```

Constructor Detail
- ColumnDescription
```
public ColumnDescription(java.lang.String typeString,
                         boolean isPrimaryKey,
                         boolean isNull,
                         java.lang.String referenceTable,
                         java.lang.String referenceColumn,
                         boolean referenceCascade)
```
  Create a column type description. Use the output of this method in the columnMap with performCreate().
  
  Parameters:
  
  typeString - is a type specification
  
  isPrimaryKey - describes whether the column is a primary key
  
  isNull - describes whether the column is nullable
  
  referenceTable - describes the reference table, if any.
  
  referenceCascade - is true if deletes should be cascaded. returns a column description object.

Method Detail

getTypeString

public java.lang.String getTypeString()

getIsPrimaryKey
```
public boolean getIsPrimaryKey()
```

getIsNull
```
public boolean getIsNull()
```

getReferenceTable

public java.lang.String getReferenceTable()

getReferenceColumn

public java.lang.String getReferenceColumn()

getReferenceCascade
```
public boolean getReferenceCascade()
```