org.cloudgraph.store.mapping

Class RowKeyModel

java.lang.Object

org.cloudgraph.store.mapping.RowKeyModel

public class RowKeyModel
extends Object

Specifies the composite row-key generation characteristics for a specific data graph. The characteristics for each pre-defined field may be specified and any number of user-defined fields may also be added to the row key. Each user defined field maps a property within the data graph to a position within the composite row key, adding another "dimension" to the key. For HBase, this user defined composite row-key approach enables the partial key-scan functionality which greatly improves query performance.

Java class for RowKeyModel complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="RowKeyModel">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="RowKeyField" type="{http://www.cloudgraph.org/config}RowKeyField" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="fieldDelimiter" type="{http://www.w3.org/2001/XMLSchema}string" default="|" />
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected String	fieldDelimiter
protected List<RowKeyField>	rowKeyFields

Constructor Summary

Constructors

Constructor and Description
RowKeyModel()

Method Summary

Modifier and Type	Method and Description
String	getFieldDelimiter() Gets the value of the fieldDelimiter property.
List<RowKeyField>	getRowKeyFields() Gets the value of the rowKeyFields property.
void	setFieldDelimiter(String value) Sets the value of the fieldDelimiter property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

rowKeyFields

protected List<RowKeyField> rowKeyFields

fieldDelimiter

protected String fieldDelimiter

Constructor Detail

RowKeyModel

public RowKeyModel()

Method Detail

getRowKeyFields

public List<RowKeyField> getRowKeyFields()

Gets the value of the rowKeyFields property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the Jakarta XML Binding object. This is why there is not a set method for the rowKeyFields property.

For example, to add a new item, do as follows:

    getRowKeyFields().add(newItem);
 

Objects of the following type(s) are allowed in the list RowKeyField

getFieldDelimiter

public String getFieldDelimiter()

Gets the value of the fieldDelimiter property.

Returns:

possible object is String

setFieldDelimiter

public void setFieldDelimiter(String value)

Sets the value of the fieldDelimiter property.

Parameters:

value - allowed object is String