Constraint (OpenJPA Parent POM 3.1.0 API)

java.lang.Object
- org.apache.openjpa.jdbc.schema.Constraint

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ForeignKey, LocalConstraint
```
public abstract class Constraint
extends Object
```
A table constraint. This class is closely aligned with the constraint information available from DatabaseMetaData.

Author:

Abe White

See Also:

Serialized Form

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`deref()`
`DBIdentifier`	`getColumnIdentifier()`
`String`	`getColumnName()` Deprecated.
`DBIdentifier`	`getFullIdentifier()`
`String`	`getFullName()` Deprecated.
`DBIdentifier`	`getIdentifier()`
`String`	`getName()` Deprecated.
`QualifiedDBIdentifier`	`getQualifiedPath()`
`int`	`getRefCount()`
`DBIdentifier`	`getSchemaIdentifier()`
`String`	`getSchemaName()` Deprecated.
`Table`	`getTable()` Return the table of this constraint.
`DBIdentifier`	`getTableIdentifier()`
`String`	`getTableName()` Deprecated.
`boolean`	`isDeferred()` Return true if this is a deferred constraint.
`abstract boolean`	`isLogical()` Return whether this constraint is a logical constraint only; i.e.
`void`	`ref()`
`void`	`setColumnIdentifier(DBIdentifier name)`
`void`	`setColumnName(String name)` Deprecated.
`void`	`setDeferred(boolean deferred)` Make this constrain deferred.
`void`	`setIdentifier(DBIdentifier name)`
`void`	`setName(String name)` Deprecated.
`void`	`setSchemaIdentifier(DBIdentifier schema)`
`void`	`setSchemaName(String schema)` Deprecated.
`void`	`setTableIdentifier(DBIdentifier name)`
`void`	`setTableName(String name)` Deprecated.
`String`	`toString()`

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

- Method Detail
  - getTable
```
public Table getTable()
```
    Return the table of this constraint.
  - getTableName
```
@Deprecated
public String getTableName()
```
    Deprecated.
    
    Return the column's table name.
  - getTableIdentifier
```
public DBIdentifier getTableIdentifier()
```
  - setTableName
```
@Deprecated
public void setTableName(String name)
```
    Deprecated.
    
    Set the column's table name. You can only call this method on columns whose table object is not set.
  - setTableIdentifier
```
public void setTableIdentifier(DBIdentifier name)
```
  - getSchemaName
```
@Deprecated
public String getSchemaName()
```
    Deprecated.
    
    Return the column table's schema name.
  - getSchemaIdentifier
```
public DBIdentifier getSchemaIdentifier()
```
  - setSchemaName
```
@Deprecated
public void setSchemaName(String schema)
```
    Deprecated.
    
    Set the column table's schema name. You can only call this method on columns whose table object is not set.
  - setSchemaIdentifier
```
public void setSchemaIdentifier(DBIdentifier schema)
```
  - getColumnName
```
@Deprecated
public String getColumnName()
```
    Deprecated.
    
    Return the column's name.
  - getColumnIdentifier
```
public DBIdentifier getColumnIdentifier()
```
  - setColumnName
```
@Deprecated
public void setColumnName(String name)
```
    Deprecated.
    
    Set the column's name. You can only call this method on columns whose table object is not set.
  - setColumnIdentifier
```
public void setColumnIdentifier(DBIdentifier name)
```
  - getName
```
@Deprecated
public String getName()
```
    Deprecated.
    
    Return the name of the constraint.
  - getIdentifier
```
public DBIdentifier getIdentifier()
```
  - setName
```
@Deprecated
public void setName(String name)
```
    Deprecated.
    
    Set the name of the constraint. This method cannot be called if the constraint already belongs to a table.
  - setIdentifier
```
public void setIdentifier(DBIdentifier name)
```
  - getFullName
```
@Deprecated
public String getFullName()
```
    Deprecated.
    
    Return the full name of the constraint.
  - getQualifiedPath
```
public QualifiedDBIdentifier getQualifiedPath()
```
  - getFullIdentifier
```
public DBIdentifier getFullIdentifier()
```
  - isLogical
```
public abstract boolean isLogical()
```
    Return whether this constraint is a logical constraint only; i.e. if it does not exist in the database.
  - isDeferred
```
public boolean isDeferred()
```
    Return true if this is a deferred constraint.
  - setDeferred
```
public void setDeferred(boolean deferred)
```
    Make this constrain deferred.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getRefCount
```
public int getRefCount()
```
  - ref
```
public void ref()
```
  - deref
```
public void deref()
```

Class Constraint

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getTable

getTableName

getTableIdentifier

setTableName

setTableIdentifier

getSchemaName

getSchemaIdentifier

setSchemaName

setSchemaIdentifier

getColumnName

getColumnIdentifier

setColumnName

setColumnIdentifier

getName

getIdentifier

setName

setIdentifier

getFullName

getQualifiedPath

getFullIdentifier

isLogical

isDeferred

setDeferred

toString

getRefCount

ref

deref