org.eclipse.jpt.db
Interface Column

All Superinterfaces:
java.lang.Comparable<Column>

public interface Column
extends java.lang.Comparable<Column>

Database column Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves. This interface is not intended to be implemented by clients.


Method Summary
 boolean dataTypeIsLOB()
          Return whether the column's datatype is a LOB type (i.e.
 java.lang.String getDataTypeName()
          Return the name of the column's datatype.
 java.lang.String getJavaFieldName()
          Return a Java-appropriate version of the column's name.
 JavaType getJavaType()
          Return a Java type that is reasonably similar to the column's data type.
 java.lang.String getJavaTypeDeclaration()
          Return a Java type declaration that is reasonably similar to the column's data type.
 java.lang.String getName()
          Return the column's name.
 JavaType getPrimaryKeyJavaType()
          Return a Java type that is reasonably similar to the column's data type and suitable for use as a primary key field.
 java.lang.String getPrimaryKeyJavaTypeDeclaration()
          Return a Java type declaration that is reasonably similar to the column's data type and suitable for use as a primary key field.
 boolean matchesJavaFieldName(java.lang.String javaFieldName)
          Return whether the column's name matches the specified Java identifier, respecting the database's case-sensitivity.
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

getName

java.lang.String getName()
Return the column's name.


getDataTypeName

java.lang.String getDataTypeName()
Return the name of the column's datatype.


getJavaFieldName

java.lang.String getJavaFieldName()
Return a Java-appropriate version of the column's name.


matchesJavaFieldName

boolean matchesJavaFieldName(java.lang.String javaFieldName)
Return whether the column's name matches the specified Java identifier, respecting the database's case-sensitivity.


getPrimaryKeyJavaTypeDeclaration

java.lang.String getPrimaryKeyJavaTypeDeclaration()
Return a Java type declaration that is reasonably similar to the column's data type and suitable for use as a primary key field.


getPrimaryKeyJavaType

JavaType getPrimaryKeyJavaType()
Return a Java type that is reasonably similar to the column's data type and suitable for use as a primary key field.


getJavaTypeDeclaration

java.lang.String getJavaTypeDeclaration()
Return a Java type declaration that is reasonably similar to the column's data type.


getJavaType

JavaType getJavaType()
Return a Java type that is reasonably similar to the column's data type.


dataTypeIsLOB

boolean dataTypeIsLOB()
Return whether the column's datatype is a LOB type (i.e. BLOB, CLOB, or NCLOB).