org.modeshape.jcr.api.query.QueryResult Maven / Gradle / Ivy
/*
* ModeShape (http://www.modeshape.org)
* See the COPYRIGHT.txt file distributed with this work for information
* regarding copyright ownership. Some portions may be licensed
* to Red Hat, Inc. under one or more contributor license agreements.
* See the AUTHORS.txt file in the distribution for a full listing of
* individual contributors.
*
* ModeShape is free software. Unless otherwise indicated, all code in ModeShape
* is licensed to you under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* ModeShape is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.modeshape.jcr.api.query;
import java.util.Collection;
import javax.jcr.PropertyType;
/**
* Replicates some of the methods introduced in JCR 2.0, but also provides an extension that allows accessing the JCR
* {@link PropertyType} for each of the columns.
*/
public interface QueryResult extends javax.jcr.query.QueryResult {
/**
* Returns an array of the {@link PropertyType} name for each of the columns in this result.
*
* @return the array of property type names; never null, never has null elements, and the size always matches
* {@link QueryResult#getColumnNames()}.
*/
public String[] getColumnTypes();
/**
* Get a description of ModeShape's plan for executing this query. The plan uses relational algebra and operations, and may be
* used to get insight into what operations are performed when executing the query.
*
* Note that as of ModeShape 3.1, the plan is always captured and available, though this may change in future versions. This
* means that clients should be written to never expect a non-null String response from this method.
*
*
* @return the string representation of the query plan as executed by the query; may be null if the query plan was not
* captured for the query (though currently it is always captured)
*/
public String getPlan();
/**
* Get any warnings that might describe potential problems with this query.
*
* Note that a query that has warnings is not necessarily incorrect or potentially wrong - because of residual properties,
* ModeShape may produce warnings for queries that are perfectly valid.
*
*
* However, if a query does not give the expected results (during development), check the warnings to see if ModeShape can
* suggest specific things to look at. For example, a warnings might suggest that a column might be resolved on a different
* selector, or that a column might have been misspelled.
*
*
* @return the collection of warnings; never null be empty when there are no warnings
*/
public Collection getWarnings();
}