Package org.apache.cayenne.access.jdbc

Class ColumnDescriptor

java.lang.Object

org.apache.cayenne.access.jdbc.ColumnDescriptor

public class ColumnDescriptor
extends Object

A descriptor of a ResultSet column.

Since:

1.1

Field Summary

Fields

Modifier and Type	Field	Description
protected DbAttribute	attribute
protected String	dataRowKey
protected boolean	isExpression
protected String	javaClass
protected int	jdbcType
protected String	name
protected String	namePrefix
protected String	procedureName
protected String	tableName

Constructor Summary

Constructors

Constructor	Description
ColumnDescriptor()	Creates a ColumnDescriptor
ColumnDescriptor(String columnName, int jdbcType)	Creates a column descriptor with user-specified parameters.
ColumnDescriptor(String columnName, int jdbcType, String javaClass)
ColumnDescriptor(String columnName, ResultSetMetaData metaData, int position)	Creates a ColumnDescriptor using ResultSetMetaData.
ColumnDescriptor(ResultSetMetaData metaData, int position)	Creates a ColumnDescriptor using ResultSetMetaData.
ColumnDescriptor(DbAttribute attribute, String tableAlias)	Creates a ColumnDescriptor from Cayenne DbAttribute.
ColumnDescriptor(ObjAttribute objAttribute, DbAttribute dbAttribute, String columnAlias)
ColumnDescriptor(ProcedureParameter parameter)	Creates a ColumnDescriptor from stored procedure parameter.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)	Returns true if another object is a ColumnDescriptor with the same name, name prefix, table and procedure names.
DbAttribute	getAttribute()	Returns a DbAttribute for this column.
String	getDataRowKey()
String	getJavaClass()
int	getJdbcType()
String	getName()	Returns column name.
String	getNamePrefix()
String	getProcedureName()	Returns the name of the parent stored procedure.
String	getQualifiedColumnName()	Returns "qualifiedColumnName" property.
String	getTableName()	Returns the name of the parent table.
int	hashCode()
boolean	isExpression()
void	setAttribute(DbAttribute attribute)
void	setDataRowKey(String dataRowKey)
void	setIsExpression(boolean isExpression)
void	setJavaClass(String string)
void	setJdbcType(int i)
void	setName(String name)
void	setProcedureName(String procedureName)
void	setTableName(String tableName)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

attribute

protected DbAttribute attribute

tableName

protected String tableName

procedureName

protected String procedureName

name

protected String name

namePrefix

protected String namePrefix

dataRowKey

protected String dataRowKey

jdbcType

protected int jdbcType

javaClass

protected String javaClass

isExpression

protected boolean isExpression

Since:

4.0

Constructor Details

ColumnDescriptor

public ColumnDescriptor()

Creates a ColumnDescriptor

ColumnDescriptor

public ColumnDescriptor(String columnName,
 int jdbcType)

Creates a column descriptor with user-specified parameters.

Since:

3.1

ColumnDescriptor

public ColumnDescriptor(String columnName,
 int jdbcType,
 String javaClass)

Since:

4.0

ColumnDescriptor

public ColumnDescriptor(DbAttribute attribute,
 String tableAlias)

Creates a ColumnDescriptor from Cayenne DbAttribute.

Since:

1.2

ColumnDescriptor

public ColumnDescriptor(ObjAttribute objAttribute,
 DbAttribute dbAttribute,
 String columnAlias)

Since:

1.2

ColumnDescriptor

public ColumnDescriptor(ProcedureParameter parameter)

Creates a ColumnDescriptor from stored procedure parameter.

Since:

1.2

ColumnDescriptor

public ColumnDescriptor(String columnName,
 ResultSetMetaData metaData,
 int position)
                 throws SQLException

Creates a ColumnDescriptor using ResultSetMetaData.

Throws:

SQLException

Since:

3.1

ColumnDescriptor

public ColumnDescriptor(ResultSetMetaData metaData,
 int position)
                 throws SQLException

Creates a ColumnDescriptor using ResultSetMetaData.

Throws:

SQLException

Since:

1.2

Method Details

getAttribute

public DbAttribute getAttribute()

Returns a DbAttribute for this column. Since columns descriptors can be initialized in a context where a DbAttribite is unknown, this method may return null.

Since:

4.0

setAttribute

public void setAttribute(DbAttribute attribute)

equals

public boolean equals(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 Object

Since:

1.2

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Since:

1.2

toString

public String toString()

Overrides:

toString in class Object

Since:

1.2

getQualifiedColumnName

public String getQualifiedColumnName()

Returns "qualifiedColumnName" property.

Since:

1.2

getJdbcType

public int getJdbcType()

getName

public String getName()

Returns column name. Name is an unqualified column name in a query.

getNamePrefix

public String getNamePrefix()

Since:

4.0

setJdbcType

public void setJdbcType(int i)

setName

public void setName(String name)

getJavaClass

public String getJavaClass()

setJavaClass

public void setJavaClass(String string)

getTableName

public String getTableName()

Returns the name of the parent table.

Since:

1.2

setTableName

public void setTableName(String tableName)

Since:

1.2

getProcedureName

public String getProcedureName()

Returns the name of the parent stored procedure.

Since:

1.2

setProcedureName

public void setProcedureName(String procedureName)

Since:

1.2

getDataRowKey

public String getDataRowKey()

Since:

3.0

setDataRowKey

public void setDataRowKey(String dataRowKey)

Since:

3.0

setIsExpression

public void setIsExpression(boolean isExpression)

Parameters:

isExpression - is this column is an expression

Since:

4.0

isExpression

public boolean isExpression()

Returns:

is this column is an expression

Since:

4.0