org.apache.jackrabbit.spi.commons.query.jsr283.qom
Interface Column

All Known Implementing Classes:

ColumnImpl

public interface Column

Defines a column to include in the tabular view of query results.

If property is not specified, a column is included for each single-valued non-residual property of the node type specified by the nodeType attribute of selector.

If property is specified, columnName is required and used to name the column in the tabular results. If property is not specified, columnName must not be specified, and the included columns will be named "selector.propertyName".

The query is invalid if:

• selector is not the name of a selector in the query, or
• property is specified but it not a a syntactically valid JCR name, or
• property is specified but does not evaluate to a scalar value, or
• property is specified but columnName is omitted, or
• property is omitted but columnName is specified, or
• the columns in the tabular view are not uniquely named, whether those column names are specified by columnName (if property is specified) or generated as described above (if property is omitted).

If property is specified but, for a node-tuple, the selector node does not have a property named property, the query is valid and the column has null value.

Since:

JCR 2.0

Method Summary

String	getColumnName() Gets the column name.
String	getPropertyName() Gets the name of the property.
String	getSelectorName() Gets the name of the selector.

Method Detail

getSelectorName

String getSelectorName()

Gets the name of the selector.

Returns:

the selector name; non-null

getPropertyName

String getPropertyName()

Gets the name of the property.

Returns:

the property name, or null to include a column for each single-value non-residual property of the selector's node type

getColumnName

String getColumnName()

Gets the column name.

Returns:

the column name; must be null if getPropertyName is null and non-null otherwise