javax.jcr.query.qom.Column Maven / Gradle / Ivy
Show all versions of aem-sdk-api Show documentation
/*
* Copyright 2009 Day Management AG, Switzerland. All rights reserved.
*/
package javax.jcr.query.qom;
/**
* Defines a column to include in the tabular view of query results.
*
* If {@link #getPropertyName 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 {@link #getSelectorName selector}.
*
* If {@link #getPropertyName property} is specified, {@link #getColumnName
* columnName} is required and used to name the column in the tabular results.
* If {@link #getPropertyName property} is not specified, {@link #getColumnName
* columnName} must not be specified, and the included columns will be named
* "{@link #getSelectorName selector}.propertyName".
*
* @since JCR 2.0
*/
public interface Column {
/**
* Gets the name of the selector.
*
* @return the selector name; non-null
*/
public String getSelectorName();
/**
* Gets the name of the property.
*
* @return the property name, or null to include a column for each
* single-value non-residual property of the selector's node type
*/
public String getPropertyName();
/**
* Gets the column name.
*
*
* @return the column name; must be null if getPropertyName
is
* null and non-null otherwise
*/
public String getColumnName();
}