org.apache.cayenne.access.jdbc
Class ColumnDescriptor

java.lang.Object
  extended by org.apache.cayenne.access.jdbc.ColumnDescriptor
All Implemented Interfaces:
java.io.Serializable

public class ColumnDescriptor
extends java.lang.Object
implements java.io.Serializable

A descriptor of a ResultSet column.

Since:
1.1
See Also:
Serialized Form

Field Summary
protected  java.lang.String dataRowKey
           
protected  java.lang.String javaClass
           
protected  int jdbcType
           
protected  java.lang.String name
           
protected  java.lang.String namePrefix
           
protected  java.lang.String procedureName
           
protected  java.lang.String tableName
           
 
Constructor Summary
ColumnDescriptor()
          Creates a ColumnDescriptor
ColumnDescriptor(DbAttribute attribute, java.lang.String tableAlias)
          Creates a ColumnDescriptor from Cayenne DbAttribute.
ColumnDescriptor(ObjAttribute objAttribute, DbAttribute dbAttribute, java.lang.String columnAlias)
           
ColumnDescriptor(ProcedureParameter parameter)
          Creates a ColumnDescriptor from stored procedure parameter.
ColumnDescriptor(java.sql.ResultSetMetaData metaData, int position)
          Creates a ColumnDescriptor using ResultSetMetaData.
ColumnDescriptor(java.lang.String columnName, int jdbcType)
          Creates a column descriptor with user-specified parameters.
ColumnDescriptor(java.lang.String columnName, int jdbcType, java.lang.String javaClass)
          Deprecated. since 3.1 use ColumnDescriptor(String columnName, int jdbcType) instead
ColumnDescriptor(java.lang.String columnName, java.sql.ResultSetMetaData metaData, int position)
          Creates a ColumnDescriptor using ResultSetMetaData.
 
Method Summary
 boolean equals(java.lang.Object o)
          Returns true if another object is a ColumnDescriptor with the same name, name prefix, table and procedure names.
 java.lang.String getDataRowKey()
           
 java.lang.String getDefaultJavaClass(int size, int scale)
          Deprecated. use TypesMapping.getJavaBySqlType(int type) instead
 java.lang.String getJavaClass()
           
 int getJdbcType()
           
 java.lang.String getName()
          Returns column name.
 java.lang.String getProcedureName()
          Returns the name of the parent stored procedure.
 java.lang.String getQualifiedColumnName()
          Returns "qualifiedColumnName" property.
 java.lang.String getQualifiedColumnNameWithQuoteSqlIdentifiers(QuotingStrategy strategy)
           
 java.lang.String getTableName()
          Returns the name of the parent table.
 int hashCode()
           
 void setDataRowKey(java.lang.String dataRowKey)
           
 void setJavaClass(java.lang.String string)
           
 void setJdbcType(int i)
           
 void setName(java.lang.String name)
           
 void setProcedureName(java.lang.String procedureName)
           
 void setTableName(java.lang.String tableName)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

tableName

protected java.lang.String tableName

procedureName

protected java.lang.String procedureName

name

protected java.lang.String name

namePrefix

protected java.lang.String namePrefix

dataRowKey

protected java.lang.String dataRowKey

jdbcType

protected int jdbcType

javaClass

protected java.lang.String javaClass
Constructor Detail

ColumnDescriptor

public ColumnDescriptor()
Creates a ColumnDescriptor


ColumnDescriptor

@Deprecated
public ColumnDescriptor(java.lang.String columnName,
                                   int jdbcType,
                                   java.lang.String javaClass)
Deprecated. since 3.1 use ColumnDescriptor(String columnName, int jdbcType) instead

Creates a column descriptor with user-specified parameters.

Since:
1.2

ColumnDescriptor

public ColumnDescriptor(java.lang.String columnName,
                        int jdbcType)
Creates a column descriptor with user-specified parameters.

Since:
3.1

ColumnDescriptor

public ColumnDescriptor(DbAttribute attribute,
                        java.lang.String tableAlias)
Creates a ColumnDescriptor from Cayenne DbAttribute.

Since:
1.2

ColumnDescriptor

public ColumnDescriptor(ObjAttribute objAttribute,
                        DbAttribute dbAttribute,
                        java.lang.String columnAlias)
Since:
1.2

ColumnDescriptor

public ColumnDescriptor(ProcedureParameter parameter)
Creates a ColumnDescriptor from stored procedure parameter.

Since:
1.2

ColumnDescriptor

public ColumnDescriptor(java.lang.String columnName,
                        java.sql.ResultSetMetaData metaData,
                        int position)
                 throws java.sql.SQLException
Creates a ColumnDescriptor using ResultSetMetaData.

Throws:
java.sql.SQLException
Since:
3.1

ColumnDescriptor

public ColumnDescriptor(java.sql.ResultSetMetaData metaData,
                        int position)
                 throws java.sql.SQLException
Creates a ColumnDescriptor using ResultSetMetaData.

Throws:
java.sql.SQLException
Since:
1.2
Method Detail

equals

public boolean equals(java.lang.Object o)
Returns true if another object is a ColumnDescriptor with the same name, name prefix, table and procedure names. Other fields are ignored in the equality test.

Overrides:
equals in class java.lang.Object
Since:
1.2

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object
Since:
1.2

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object
Since:
1.2

getDefaultJavaClass

@Deprecated
public java.lang.String getDefaultJavaClass(int size,
                                                       int scale)
Deprecated. use TypesMapping.getJavaBySqlType(int type) instead

Returns a default Java class for an internal JDBC type.

Since:
1.2

getQualifiedColumnName

public java.lang.String getQualifiedColumnName()
Returns "qualifiedColumnName" property.

Since:
1.2

getQualifiedColumnNameWithQuoteSqlIdentifiers

public java.lang.String getQualifiedColumnNameWithQuoteSqlIdentifiers(QuotingStrategy strategy)

getJdbcType

public int getJdbcType()

getName

public java.lang.String getName()
Returns column name. Name is an unqualified column name in a query.


setJdbcType

public void setJdbcType(int i)

setName

public void setName(java.lang.String name)

getJavaClass

public java.lang.String getJavaClass()

setJavaClass

public void setJavaClass(java.lang.String string)

getTableName

public java.lang.String getTableName()
Returns the name of the parent table.

Since:
1.2

setTableName

public void setTableName(java.lang.String tableName)
Since:
1.2

getProcedureName

public java.lang.String getProcedureName()
Returns the name of the parent stored procedure.

Since:
1.2

setProcedureName

public void setProcedureName(java.lang.String procedureName)
Since:
1.2

getDataRowKey

public java.lang.String getDataRowKey()
Since:
3.0

setDataRowKey

public void setDataRowKey(java.lang.String dataRowKey)
Since:
3.0


Copyright © 2001-2012 Apache Cayenne. All Rights Reserved.