org.apache.jackrabbit.spi.QueryResultRow Maven / Gradle / Ivy

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.jackrabbit.spi;

/**
 * QueryResultRow represents the SPI equivalent of a query result
 * row. It provides access to the id of the Node this row represents as well
 * as to the score and to the values represented in this result row.
 */
public interface QueryResultRow {

    /**
     * Returns {@link NodeId} of node for a given selectorname this
     * result row represents.
     *
     * @param selectorName the name of a selector or null for the
     *                     default selector.
     * @return node id of the Node this result row represents or
     *         null if there is no node present in this row for the
     *         given selector name.
     * @see javax.jcr.query.Row#getNode()
     * @see javax.jcr.query.Row#getNode(String)
     */
    public NodeId getNodeId(String selectorName);

    /**
     * Returns score for the given selectorName of this result row.
     *
     * @param selectorName the name of a selector or null for the
     *                     default selector.
     * @return score for the given selector in this result row.
     */
    public double getScore(String selectorName);

    /**
     * Returns an array of QValues.
     *
     * @return an array of QValues representing the values present
     * in this result row.
     * @see javax.jcr.query.Row#getValue(String)
     * @see javax.jcr.query.Row#getValues()
     */
    public QValue[] getValues();
}