org.cloudgraph.store.key.GraphStatefullColumnKeyFactory Maven / Gradle / Ivy

Go to download
/**
 * Copyright 2017 TerraMeta Software, 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 org.cloudgraph.store.key;

import org.plasma.sdo.PlasmaDataObject;
import org.plasma.sdo.PlasmaProperty;
import org.plasma.sdo.PlasmaType;

/**
 * Generates a column key based on the configured CloudGraph column key
 * {@link org.cloudgraph.config.ColumnKeyModel model} for a specific table
 * {@link org.cloudgraph.config.Table configuration}.
 * 
 * The initial creation and subsequent re-constitution for query retrieval
 * purposes of both row and column keys in CloudGraph™ is efficient, as it
 * leverages byte array level API in both Java and the current underlying SDO
 * 2.1 implementation, PlasmaSDO™. Both composite row and
 * column keys are composed in part of structural metadata, and the lightweight
 * metadata API within PlasmaSDO™ contains byte-array level,
 * cached lookup of all basic metadata elements including logical and physical
 * type and property names.
 * 
 * 
 * @see org.cloudgraph.config.ColumnKeyModel
 * @see org.cloudgraph.config.Table
 * @author Scott Cinnamond
 * @since 0.5
 */
public interface GraphStatefullColumnKeyFactory extends GraphColumnKeyFactory {

  /**
   * Generates and returns a column key based on the given arguments as well as
   * the configured CloudGraph column key
   * {@link org.cloudgraph.config.ColumnKeyModel model} for a specific table
   * {@link org.cloudgraph.config.Table configuration}.
   * 
   * @param dataObject
   *          the data object
   * @param sequenceNum
   *          the graph row specific sequence number for the type associated
   *          with the given data object
   * @param property
   *          the property
   * @return the column key bytes
   */
  public byte[] createColumnKey(PlasmaDataObject dataObject, long sequenceNum,
      PlasmaProperty property);

  /**
   * Generates and returns a column key based on the given arguments as well as
   * the configured CloudGraph column key
   * {@link org.cloudgraph.config.ColumnKeyModel model} for a specific table
   * {@link org.cloudgraph.config.Table configuration}.
   * 
   * @param dataObject
   *          the data object
   * @param sequenceNum
   *          the graph row specific sequence number for the type associated
   *          with the given data object
   * @param property
   *          the property
   * @param metaField
   *          the meta field
   * @return the column key bytes
   */
  public byte[] createColumnKey(PlasmaDataObject dataObject, long sequenceNum,
      PlasmaProperty property, EdgeMetaKey metaField);

  public byte[] createColumnKey(PlasmaType type, long sequenceNum, PlasmaProperty property,
      EntityMetaKey metaField);

  public byte[] createColumnKey(PlasmaType type, long sequenceNum, PlasmaProperty property,
      EdgeMetaKey metaField);

  public byte[] createColumnKey(PlasmaType type, long sequenceNum, EntityMetaKey metaField);

  public byte[] createColumnKey(PlasmaType type, long sequenceNum, EdgeMetaKey metaField);

  /**
   * Generates and returns a column key based on data graph specific sequence
   * number for a given data object, and using the given metadata property as
   * well as the configured CloudGraph column key
   * {@link org.cloudgraph.config.ColumnKeyModel model} for a specific table
   * {@link org.cloudgraph.config.Table configuration}.
   * 
   * @param type
   *          the metadata type
   * @param sequenceNum
   *          the graph row specific sequence number for the given type for a
   *          data object
   * @param property
   *          the property
   * @return the column key bytes
   */
  public byte[] createColumnKey(PlasmaType type, long sequenceNum, PlasmaProperty property);

  /**
   * Generates and returns a column key metadata prefix based on data graph
   * specific sequence number for a given data object.
   * {@link org.cloudgraph.config.ColumnKeyModel model} for a specific table
   * {@link org.cloudgraph.config.Table configuration}.
   * 
   * @param type
   *          the metadata type
   * @param sequenceNum
   *          the graph row specific sequence number for the given type for a
   *          data object
   * @param property
   *          the property
   * @return the column key prefix bytes
   */
  public byte[] createColumnKeyMetadataPrefix(PlasmaType type, long sequenceNum,
      PlasmaProperty property);
}