com.cinchapi.impromptu.server.api.Datastore Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of impromptu-recipe-api Show documentation

APIs for Impromput data derivation recipes.

The newest version!

/*
 * Copyright (c) 2013-2017 Cinchapi Inc.
 * 
 * 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.cinchapi.impromptu.server.api;

/**
 * A {@link Datastore} is place into which derived data can be inserted.
 * 
 * @author Jeff Nelson
 */
public interface Datastore {

    /**
     * Insert {@code attribute} as {@code value} within {@code record} into this
     * {@link Datastore}.
     * 
     * @param record the record of the entry
     * @param key the key of the entry
     * @param value the value of the entry
     * @return {@code true} if the data is inserted into the datastore
     */
    public boolean insert(Long record, String attribute, Object value);

}