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 DbAttributeattributeprotected StringdataRowKeyprotected booleanisExpressionprotected StringjavaClassprotected intjdbcTypeprotected Stringnameprotected StringnamePrefixprotected StringprocedureNameprotected StringtableName -
Constructor Summary
Constructors Constructor Description ColumnDescriptor()Creates a ColumnDescriptorColumnDescriptor(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 booleanequals(Object o)Returns true if another object is a ColumnDescriptor with the same name, name prefix, table and procedure names.DbAttributegetAttribute()Returns a DbAttribute for this column.StringgetDataRowKey()StringgetJavaClass()intgetJdbcType()StringgetName()Returns column name.StringgetNamePrefix()StringgetProcedureName()Returns the name of the parent stored procedure.StringgetQualifiedColumnName()Returns "qualifiedColumnName" property.StringgetTableName()Returns the name of the parent table.inthashCode()booleanisExpression()voidsetAttribute(DbAttribute attribute)voidsetDataRowKey(String dataRowKey)voidsetIsExpression(boolean isExpression)voidsetJavaClass(String string)voidsetJdbcType(int i)voidsetName(String name)voidsetProcedureName(String procedureName)voidsetTableName(String tableName)StringtoString()
-
Field Details
-
attribute
-
tableName
-
procedureName
-
name
-
namePrefix
-
dataRowKey
-
jdbcType
protected int jdbcType -
javaClass
-
isExpression
protected boolean isExpression- Since:
- 4.0
-
-
Constructor Details
-
ColumnDescriptor
public ColumnDescriptor()Creates a ColumnDescriptor -
ColumnDescriptor
Creates a column descriptor with user-specified parameters.- Since:
- 3.1
-
ColumnDescriptor
- Since:
- 4.0
-
ColumnDescriptor
Creates a ColumnDescriptor from Cayenne DbAttribute.- Since:
- 1.2
-
ColumnDescriptor
- Since:
- 1.2
-
ColumnDescriptor
Creates a ColumnDescriptor from stored procedure parameter.- Since:
- 1.2
-
ColumnDescriptor
public ColumnDescriptor(String columnName, ResultSetMetaData metaData, int position) throws SQLExceptionCreates a ColumnDescriptor using ResultSetMetaData.- Throws:
SQLException- Since:
- 3.1
-
ColumnDescriptor
Creates a ColumnDescriptor using ResultSetMetaData.- Throws:
SQLException- Since:
- 1.2
-
-
Method Details
-
setAttribute
-
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
-
equals
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. -
hashCode
public int hashCode() -
toString
-
getQualifiedColumnName
Returns "qualifiedColumnName" property.- Since:
- 1.2
-
getJdbcType
public int getJdbcType() -
getName
Returns column name. Name is an unqualified column name in a query. -
getNamePrefix
- Since:
- 4.0
-
setJdbcType
public void setJdbcType(int i) -
setName
-
getJavaClass
-
setJavaClass
-
getTableName
Returns the name of the parent table.- Since:
- 1.2
-
setTableName
- Since:
- 1.2
-
getProcedureName
Returns the name of the parent stored procedure.- Since:
- 1.2
-
setProcedureName
- Since:
- 1.2
-
getDataRowKey
- Since:
- 3.0
-
setDataRowKey
- 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
-