com.ebuddy.cassandra.StructuredDataSupport Maven / Gradle / Ivy
/*
* Copyright 2013 eBuddy B.V.
*
* 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.ebuddy.cassandra;
/**
*
* Provides data access for structured objects in Cassandra.
* Objects are read using a hierarchical path that must contain at least one path element.
* When reading values, they will be constructed as the specified type in a TypeReference.
* Any object that can be converted to JSON can be written to a path. Jackson annotations can be used
* to customize how the object is converted. See Jackson JSON Processor.
*
*
* Paths that refer to list elements use a special notation, the '@' symbol followed by
* the element index within the list (as a string).
*
* @param The row key type
* @see Jackson JSON Processor
* @author Eric Zoerner [email protected]>Jackson
*/
public interface StructuredDataSupport {
/**
* Begin a batch operation. Returns a BatchContext object which must be passed to all methods that participate
* in this batch operation, and then is passed to applyBatch to execute the batch.
* @return the BatchContext
*/
BatchContext beginBatch();
/**
* Execute the batch.
* @param batchContext
*/
void applyBatch(BatchContext batchContext);
/**
* Read an object from a path in the database.
* @param rowKey the row key for the object to be read
* @param path the path to the object to be read
* @param type a TypeReference for the type of object to be returned
* @param the type of the object to be returned
* @return the object of type T, or null if not found
* @throws IllegalArgumentException if path is empty or contains any of the special characters '@#'
*/
T readFromPath(K rowKey, Path path, TypeReference type);
void writeToPath(K rowKey, Path path, Object value);
void writeToPath(K rowKey, Path path, Object value, BatchContext batchContext);
void deletePath(K rowKey, Path path);
void deletePath(K rowKey, Path path, BatchContext batchContext);
/**
* Utility method for creating a path string from individual string elements.
*/
Path createPath(String... elements);
}