com.marklogic.client.query.ExtractedItem Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-client-api Show documentation

The official MarkLogic Java client API.

There is a newer version: 4.0.1

/*
 * Copyright 2012-2016 MarkLogic Corporation
 *
 * Licensed 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 com.marklogic.client.query;

import com.marklogic.client.io.marker.StructureReadHandle;

/** Access the extracted XML or JSON node using any StructureReadHandle
 * or class registered by a ContentHandle. */
public interface ExtractedItem {
    /** Get the item using the specified handle.
     * @param handle a handle to populate
     * @param  the type of StructureReadHandle to return
     * @return the item represented by this instance
     */
    public  T get(T handle);

    /** Get the item using the handle registered for the specified class.
     * The IO class must have been registered before creating the database client.
     * By default, the provided handles that implement 
     * {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
     * 
     * Learn more about shortcut methods
     * 
     * @param as a Class type that has been registered by a handle
     * @param  the type of object that will be returned by the handle registered for it
     * @return the item represented by this instance
     */
    public  T getAs(Class as);
}