HFactory (hector-core 2.0-0 API)

java.lang.Object
- me.prettyprint.hector.api.factory.HFactory

```
public final class HFactory
extends Object
```
A convenience class with bunch of factory static methods to help create a mutator, queries etc.

Author:

Ran, zznate

Constructor Summary

Constructors
Constructor and Description

HFactory()

Constructors
Constructor and Description
`HFactory()`

Method Summary

Methods
Modifier and Type	Method and Description
`static long`	`createClock()` Creates a clock of now with the default clock resolution (micorosec) as defined in `CassandraHostConfigurator`.
`static ClockResolution`	`createClockResolution(String clockResolutionName)` Create a clock resolution based on `clockResolutionName` which has to match any of the constants defined at `ClockResolution`
`static Cluster`	`createCluster(String clusterName, CassandraHostConfigurator cassandraHostConfigurator)` Deprecated. use getOrCreateCluster instead
`static Cluster`	`createCluster(String clusterName, CassandraHostConfigurator cassandraHostConfigurator, Map<String,String> credentials)` Method looks in the cache for the cluster by name.
`static <N,V> HColumn<N,V>`	`createColumn(N name, V value)` Creates a column without specifying serializers.
`static <N,V> HColumn<N,V>`	`createColumn(N name, V value, int ttl, Serializer<N> nameSerializer, Serializer<V> valueSerializer)` Similar to the four argument version (including the clock creation) except we accept a TTL (DEFINED IN SECONDS SINCE THE TIMESTAMP [aka "clock"])
`static <N,V> HColumn<N,V>`	`createColumn(N name, V value, long clock)` Creates a column without specifying serializers.
`static <N,V> HColumn<N,V>`	`createColumn(N name, V value, long clock, int ttl, Serializer<N> nameSerializer, Serializer<V> valueSerializer)` Create a column with a user-defined clock and TTL (DEFINED IN SECONDS SINCE THE TIMESTAMP [aka "clock"]).
`static <N,V> HColumn<N,V>`	`createColumn(N name, V value, long clock, Serializer<N> nameSerializer, Serializer<V> valueSerializer)` Creates a column with a user-specified clock.
`static <N,V> HColumn<N,V>`	`createColumn(N name, V value, Serializer<N> nameSerializer, Serializer<V> valueSerializer)` Creates a column with the clock as defined by `createClock()` If you want to define a clock explicitly, use one of the overloaded forms below which take a clock, and call `Keyspace.createClock()`
`static ColumnFamilyDefinition`	`createColumnFamilyDefinition(String keyspace, String cfName)` Create a column family for a given keyspace without comparator type.
`static ColumnFamilyDefinition`	`createColumnFamilyDefinition(String keyspace, String cfName, ComparatorType comparatorType)` Create a column family for a given keyspace without comparator type.
`static ColumnFamilyDefinition`	`createColumnFamilyDefinition(String keyspace, String cfName, ComparatorType comparatorType, List<ColumnDefinition> columnMetadata)`
`static <K,N,V> ColumnQuery<K,N,V>`	`createColumnQuery(Keyspace keyspace, Serializer<K> keySerializer, Serializer<N> nameSerializer, Serializer<V> valueSerializer)`
`static <N> HCounterColumn<N>`	`createCounterColumn(N name, long value, Serializer<N> nameSerializer)` Create a counter column with a name and long value
`static HCounterColumn<String>`	`createCounterColumn(String name, long value)` Convenient method for creating a counter column with a String name and long value
`static <K,N> CounterQuery<K,N>`	`createCounterColumnQuery(Keyspace keyspace, Serializer<K> keySerializer, Serializer<N> nameSerializer)`
`static <K,N> SliceCounterQuery<K,N>`	`createCounterSliceQuery(Keyspace keyspace, Serializer<K> keySerializer, Serializer<N> nameSerializer)`
`static <SN,N> HCounterSuperColumn<SN,N>`	`createCounterSuperColumn(SN name, List<HCounterColumn<N>> columns, Serializer<SN> superNameSerializer, Serializer<N> nameSerializer)`
`static <K,N> CountQuery<K,N>`	`createCountQuery(Keyspace keyspace, Serializer<K> keySerializer, Serializer<N> nameSerializer)`
`static ConsistencyLevelPolicy`	`createDefaultConsistencyLevelPolicy()`
`static <K,N,V> IndexedSlicesQuery<K,N,V>`	`createIndexedSlicesQuery(Keyspace keyspace, Serializer<K> keySerializer, Serializer<N> nameSerializer, Serializer<V> valueSerializer)` Deprecated.
`static Keyspace`	`createKeyspace(String keyspace, Cluster cluster)` Creates a Keyspace with the default consistency level policy.
`static Keyspace`	`createKeyspace(String keyspace, Cluster cluster, ConsistencyLevelPolicy consistencyLevelPolicy)` Creates a Keyspace with the given consistency level.
`static Keyspace`	`createKeyspace(String keyspace, Cluster cluster, ConsistencyLevelPolicy consistencyLevelPolicy, FailoverPolicy failoverPolicy)` Creates a Keyspace with the given consistency level.
`static Keyspace`	`createKeyspace(String keyspace, Cluster cluster, ConsistencyLevelPolicy consistencyLevelPolicy, FailoverPolicy failoverPolicy, Map<String,String> credentials)` Creates a Keyspace with the given consistency level, fail over policy and user credentials.
`static KeyspaceDefinition`	`createKeyspaceDefinition(String keyspace)` Use createKeyspaceDefinition to add a new Keyspace to cluster.
`static KeyspaceDefinition`	`createKeyspaceDefinition(String keyspaceName, String strategyClass, int replicationFactor, List<ColumnFamilyDefinition> cfDefs)` Use createKeyspaceDefinition to add a new Keyspace to cluster.
`static <K,N> MultigetSliceCounterQuery<K,N>`	`createMultigetSliceCounterQuery(Keyspace keyspace, Serializer<K> keySerializer, Serializer<N> nameSerializer)`
`static <K,N,V> MultigetSliceQuery<K,N,V>`	`createMultigetSliceQuery(Keyspace keyspace, Serializer<K> keySerializer, Serializer<N> nameSerializer, Serializer<V> valueSerializer)`
`static <K,SN,N,V> MultigetSubSliceQuery<K,SN,N,V>`	`createMultigetSubSliceQuery(Keyspace keyspace, Serializer<K> keySerializer, Serializer<SN> sNameSerializer, Serializer<N> nameSerializer, Serializer<V> valueSerializer)`
`static <K,SN,N> MultigetSuperSliceCounterQuery<K,SN,N>`	`createMultigetSuperSliceCounterQuery(Keyspace keyspace, Serializer<K> keySerializer, Serializer<SN> sNameSerializer, Serializer<N> nameSerializer)`
`static <K,SN,N,V> MultigetSuperSliceQuery<K,SN,N,V>`	`createMultigetSuperSliceQuery(Keyspace keyspace, Serializer<K> keySerializer, Serializer<SN> sNameSerializer, Serializer<N> nameSerializer, Serializer<V> valueSerializer)`
`static <K,N,V> Mutator<K>`	`createMutator(Keyspace keyspace, Serializer<K> keySerializer)` Creates a mutator for updating records in a keyspace.
`static <K,N,V> Mutator<K>`	`createMutator(Keyspace keyspace, Serializer<K> keySerializer, BatchSizeHint sizeHint)`
`static <K,N> RangeSlicesCounterQuery<K,N>`	`createRangeSlicesCounterQuery(Keyspace keyspace, Serializer<K> keySerializer, Serializer<N> nameSerializer)`
`static <K,N,V> RangeSlicesQuery<K,N,V>`	`createRangeSlicesQuery(Keyspace keyspace, Serializer<K> keySerializer, Serializer<N> nameSerializer, Serializer<V> valueSerializer)`
`static <K,SN,N> RangeSubSlicesCounterQuery<K,SN,N>`	`createRangeSubSlicesCounterQuery(Keyspace keyspace, Serializer<K> keySerializer, Serializer<SN> sNameSerializer, Serializer<N> nameSerializer)`
`static <K,SN,N,V> RangeSubSlicesQuery<K,SN,N,V>`	`createRangeSubSlicesQuery(Keyspace keyspace, Serializer<K> keySerializer, Serializer<SN> sNameSerializer, Serializer<N> nameSerializer, Serializer<V> valueSerializer)`
`static <K,SN,N> RangeSuperSlicesCounterQuery<K,SN,N>`	`createRangeSuperSlicesCounterQuery(Keyspace keyspace, Serializer<K> keySerializer, Serializer<SN> sNameSerializer, Serializer<N> nameSerializer)`
`static <K,SN,N,V> RangeSuperSlicesQuery<K,SN,N,V>`	`createRangeSuperSlicesQuery(Keyspace keyspace, Serializer<K> keySerializer, Serializer<SN> sNameSerializer, Serializer<N> nameSerializer, Serializer<V> valueSerializer)`
`static <K,N,V> SliceQuery<K,N,V>`	`createSliceQuery(Keyspace keyspace, Serializer<K> keySerializer, Serializer<N> nameSerializer, Serializer<V> valueSerializer)`
`static HColumn<String,String>`	`createStringColumn(String name, String value)` Convienience method for creating a column with a String name and String value
`static ColumnQuery<String,String,String>`	`createStringColumnQuery(Keyspace keyspace)`
`static <K,SN,N,V> SubColumnQuery<K,SN,N,V>`	`createSubColumnQuery(Keyspace keyspace, Serializer<K> keySerializer, Serializer<SN> sNameSerializer, Serializer<N> nameSerializer, Serializer<V> valueSerializer)`
`static <K,SN,N> SubCountQuery<K,SN,N>`	`createSubCountQuery(Keyspace keyspace, Serializer<K> keySerializer, Serializer<SN> superNameSerializer, Serializer<N> nameSerializer)`
`static <K,SN,N> SubSliceCounterQuery<K,SN,N>`	`createSubSliceCounterQuery(Keyspace keyspace, Serializer<K> keySerializer, Serializer<SN> sNameSerializer, Serializer<N> nameSerializer)`
`static <K,SN,N,V> SubSliceQuery<K,SN,N,V>`	`createSubSliceQuery(Keyspace keyspace, Serializer<K> keySerializer, Serializer<SN> sNameSerializer, Serializer<N> nameSerializer, Serializer<V> valueSerializer)`
`static <SN,N,V> HSuperColumn<SN,N,V>`	`createSuperColumn(SN name, List<HColumn<N,V>> columns, long clock, Serializer<SN> superNameSerializer, Serializer<N> nameSerializer, Serializer<V> valueSerializer)`
`static <SN,N,V> HSuperColumn<SN,N,V>`	`createSuperColumn(SN name, List<HColumn<N,V>> columns, Serializer<SN> superNameSerializer, Serializer<N> nameSerializer, Serializer<V> valueSerializer)` createSuperColumn accepts a variable number of column arguments
`static <K,SN,N,V> SuperColumnQuery<K,SN,N,V>`	`createSuperColumnQuery(Keyspace keyspace, Serializer<K> keySerializer, Serializer<SN> sNameSerializer, Serializer<N> nameSerializer, Serializer<V> valueSerializer)`
`static <K,SN> SuperCountQuery<K,SN>`	`createSuperCountQuery(Keyspace keyspace, Serializer<K> keySerializer, Serializer<SN> superNameSerializer)`
`static <K,SN,N> SuperSliceCounterQuery<K,SN,N>`	`createSuperSliceCounterQuery(Keyspace keyspace, Serializer<K> keySerializer, Serializer<SN> sNameSerializer, Serializer<N> nameSerializer)`
`static <K,SN,N,V> SuperSliceQuery<K,SN,N,V>`	`createSuperSliceQuery(Keyspace keyspace, Serializer<K> keySerializer, Serializer<SN> sNameSerializer, Serializer<N> nameSerializer, Serializer<V> valueSerializer)`
`static <E> Keyspace`	`createVirtualKeyspace(String keyspace, E keyPrefix, Serializer<E> keyPrefixSerializer, Cluster cluster)`
`static <E> Keyspace`	`createVirtualKeyspace(String keyspace, E keyPrefix, Serializer<E> keyPrefixSerializer, Cluster cluster, ConsistencyLevelPolicy consistencyLevelPolicy)`
`static <E> Keyspace`	`createVirtualKeyspace(String keyspace, E keyPrefix, Serializer<E> keyPrefixSerializer, Cluster cluster, ConsistencyLevelPolicy consistencyLevelPolicy, FailoverPolicy failoverPolicy)`
`static <E> Keyspace`	`createVirtualKeyspace(String keyspace, E keyPrefix, Serializer<E> keyPrefixSerializer, Cluster cluster, ConsistencyLevelPolicy consistencyLevelPolicy, FailoverPolicy failoverPolicy, Map<String,String> credentials)`
`static Cluster`	`getCluster(String clusterName)`
`static Cluster`	`getOrCreateCluster(String clusterName, CassandraHostConfigurator cassandraHostConfigurator)` Calls the three argument version with a null credentials map.
`static Cluster`	`getOrCreateCluster(String clusterName, CassandraHostConfigurator cassandraHostConfigurator, Map<String,String> credentials)` Method tries to create a Cluster instance for an existing Cassandra cluster.
`static Cluster`	`getOrCreateCluster(String clusterName, String hostIp)` Method tries to create a Cluster instance for an existing Cassandra cluster.
`static void`	`setClusterForTest(Cluster cluster)`
`static void`	`shutdownCluster(Cluster cluster)` Shutdown this cluster, removing it from the Map.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- HFactory
```
public HFactory()
```

Method Detail

getCluster

public static Cluster getCluster(String clusterName)

getOrCreateCluster
```
public static Cluster getOrCreateCluster(String clusterName,
                         String hostIp)
```
Method tries to create a Cluster instance for an existing Cassandra cluster. If another class already called getOrCreateCluster, the factory returns the cached instance. If the instance doesn't exist in memory, a new ThriftCluster is created and cached. Example usage for a default installation of Cassandra. String clusterName = "Test Cluster"; String host = "localhost:9160"; Cluster cluster = HFactory.getOrCreateCluster(clusterName, host); Note the host should be the hostname and port number. It is preferable to use the hostname instead of the IP address.

Parameters:
clusterName - The cluster name. This is an identifying string for the cluster, e.g. "production" or "test" etc. Clusters will be created on demand per each unique clusterName key.
hostIp - host:ip format string

Returns:

getOrCreateCluster
```
public static Cluster getOrCreateCluster(String clusterName,
                         CassandraHostConfigurator cassandraHostConfigurator)
```
Calls the three argument version with a null credentials map. getOrCreateCluster(String, me.prettyprint.cassandra.service.CassandraHostConfigurator, java.util.Map) for details.

getOrCreateCluster
```
public static Cluster getOrCreateCluster(String clusterName,
                         CassandraHostConfigurator cassandraHostConfigurator,
                         Map<String,String> credentials)
```
Method tries to create a Cluster instance for an existing Cassandra cluster. If another class already called getOrCreateCluster, the factory returns the cached instance. If the instance doesn't exist in memory, a new ThriftCluster is created and cached. Example usage for a default installation of Cassandra. String clusterName = "Test Cluster"; String host = "localhost:9160"; Cluster cluster = HFactory.getOrCreateCluster(clusterName, new CassandraHostConfigurator(host));

Parameters:
clusterName - The cluster name. This is an identifying string for the cluster, e.g. "production" or "test" etc. Clusters will be created on demand per each unique clusterName key.
cassandraHostConfigurator -
credentials - The credentials map for authenticating a Keyspace

createCluster

public static Cluster createCluster(String clusterName,
                    CassandraHostConfigurator cassandraHostConfigurator)

Deprecated. use getOrCreateCluster instead

createCluster
```
public static Cluster createCluster(String clusterName,
                    CassandraHostConfigurator cassandraHostConfigurator,
                    Map<String,String> credentials)
```
Method looks in the cache for the cluster by name. If none exists, a new ThriftCluster instance is created and added to the map of known clusters

Parameters:
clusterName - The cluster name. This is an identifying string for the cluster, e.g. "production" or "test" etc. Clusters will be created on demand per each unique clusterName key.
cassandraHostConfigurator -
credentials -

setClusterForTest

public static void setClusterForTest(Cluster cluster)

shutdownCluster
```
public static void shutdownCluster(Cluster cluster)
```
Shutdown this cluster, removing it from the Map. This operation is extremely expensive and should not be done lightly.

Parameters:
cluster -

createKeyspace
```
public static Keyspace createKeyspace(String keyspace,
                      Cluster cluster)
```
Creates a Keyspace with the default consistency level policy. Example usage. String clusterName = "Test Cluster"; String host = "localhost:9160"; Cluster cluster = HFactory.getOrCreateCluster(clusterName, host); String keyspaceName = "testKeyspace"; Keyspace myKeyspace = HFactory.createKeyspace(keyspaceName, cluster);

Parameters:
keyspace -
cluster -

Returns:

createKeyspace

public static Keyspace createKeyspace(String keyspace,
                      Cluster cluster,
                      ConsistencyLevelPolicy consistencyLevelPolicy)

Creates a Keyspace with the given consistency level. For a reference to the consistency level, please refer to http://wiki.apache.org/cassandra/API.

Parameters:: keyspace -; cluster -; consistencyLevelPolicy -
Returns:

createKeyspace

public static Keyspace createKeyspace(String keyspace,
                      Cluster cluster,
                      ConsistencyLevelPolicy consistencyLevelPolicy,
                      FailoverPolicy failoverPolicy)

Creates a Keyspace with the given consistency level. For a reference to the consistency level, please refer to http://wiki.apache.org/cassandra/API.

Parameters:: keyspace -; cluster -; consistencyLevelPolicy -; failoverPolicy -
Returns:

createKeyspace

public static Keyspace createKeyspace(String keyspace,
                      Cluster cluster,
                      ConsistencyLevelPolicy consistencyLevelPolicy,
                      FailoverPolicy failoverPolicy,
                      Map<String,String> credentials)

Creates a Keyspace with the given consistency level, fail over policy and user credentials. For a reference to the consistency level, please refer to http://wiki.apache.org/cassandra/API.

Parameters:: keyspace -; cluster -; consistencyLevelPolicy -; credentials -
Returns:

createVirtualKeyspace

public static <E> Keyspace createVirtualKeyspace(String keyspace,
                                 E keyPrefix,
                                 Serializer<E> keyPrefixSerializer,
                                 Cluster cluster)

createVirtualKeyspace

public static <E> Keyspace createVirtualKeyspace(String keyspace,
                                 E keyPrefix,
                                 Serializer<E> keyPrefixSerializer,
                                 Cluster cluster,
                                 ConsistencyLevelPolicy consistencyLevelPolicy)

createVirtualKeyspace

public static <E> Keyspace createVirtualKeyspace(String keyspace,
                                 E keyPrefix,
                                 Serializer<E> keyPrefixSerializer,
                                 Cluster cluster,
                                 ConsistencyLevelPolicy consistencyLevelPolicy,
                                 FailoverPolicy failoverPolicy)

createVirtualKeyspace

public static <E> Keyspace createVirtualKeyspace(String keyspace,
                                 E keyPrefix,
                                 Serializer<E> keyPrefixSerializer,
                                 Cluster cluster,
                                 ConsistencyLevelPolicy consistencyLevelPolicy,
                                 FailoverPolicy failoverPolicy,
                                 Map<String,String> credentials)

createDefaultConsistencyLevelPolicy

public static ConsistencyLevelPolicy createDefaultConsistencyLevelPolicy()

createMutator

public static <K,N,V> Mutator<K> createMutator(Keyspace keyspace,
                               Serializer<K> keySerializer)

Creates a mutator for updating records in a keyspace.

Parameters:: keyspace -; keySerializer -

createMutator

public static <K,N,V> Mutator<K> createMutator(Keyspace keyspace,
                               Serializer<K> keySerializer,
                               BatchSizeHint sizeHint)

createColumnQuery

public static <K,N,V> ColumnQuery<K,N,V> createColumnQuery(Keyspace keyspace,
                                           Serializer<K> keySerializer,
                                           Serializer<N> nameSerializer,
                                           Serializer<V> valueSerializer)

createCounterColumnQuery

public static <K,N> CounterQuery<K,N> createCounterColumnQuery(Keyspace keyspace,
                                               Serializer<K> keySerializer,
                                               Serializer<N> nameSerializer)

createCountQuery

public static <K,N> CountQuery<K,N> createCountQuery(Keyspace keyspace,
                                     Serializer<K> keySerializer,
                                     Serializer<N> nameSerializer)

createSuperCountQuery

public static <K,SN> SuperCountQuery<K,SN> createSuperCountQuery(Keyspace keyspace,
                                                 Serializer<K> keySerializer,
                                                 Serializer<SN> superNameSerializer)

createSubCountQuery

public static <K,SN,N> SubCountQuery<K,SN,N> createSubCountQuery(Keyspace keyspace,
                                                 Serializer<K> keySerializer,
                                                 Serializer<SN> superNameSerializer,
                                                 Serializer<N> nameSerializer)

createStringColumnQuery

public static ColumnQuery<String,String,String> createStringColumnQuery(Keyspace keyspace)

createSuperColumnQuery

public static <K,SN,N,V> SuperColumnQuery<K,SN,N,V> createSuperColumnQuery(Keyspace keyspace,
                                                           Serializer<K> keySerializer,
                                                           Serializer<SN> sNameSerializer,
                                                           Serializer<N> nameSerializer,
                                                           Serializer<V> valueSerializer)

createMultigetSliceQuery

public static <K,N,V> MultigetSliceQuery<K,N,V> createMultigetSliceQuery(Keyspace keyspace,
                                                         Serializer<K> keySerializer,
                                                         Serializer<N> nameSerializer,
                                                         Serializer<V> valueSerializer)

createMultigetSliceCounterQuery

public static <K,N> MultigetSliceCounterQuery<K,N> createMultigetSliceCounterQuery(Keyspace keyspace,
                                                                   Serializer<K> keySerializer,
                                                                   Serializer<N> nameSerializer)

createSuperSliceCounterQuery

public static <K,SN,N> SuperSliceCounterQuery<K,SN,N> createSuperSliceCounterQuery(Keyspace keyspace,
                                                                   Serializer<K> keySerializer,
                                                                   Serializer<SN> sNameSerializer,
                                                                   Serializer<N> nameSerializer)

createSubColumnQuery

public static <K,SN,N,V> SubColumnQuery<K,SN,N,V> createSubColumnQuery(Keyspace keyspace,
                                                       Serializer<K> keySerializer,
                                                       Serializer<SN> sNameSerializer,
                                                       Serializer<N> nameSerializer,
                                                       Serializer<V> valueSerializer)

createMultigetSuperSliceQuery

public static <K,SN,N,V> MultigetSuperSliceQuery<K,SN,N,V> createMultigetSuperSliceQuery(Keyspace keyspace,
                                                                         Serializer<K> keySerializer,
                                                                         Serializer<SN> sNameSerializer,
                                                                         Serializer<N> nameSerializer,
                                                                         Serializer<V> valueSerializer)

createMultigetSuperSliceCounterQuery

public static <K,SN,N> MultigetSuperSliceCounterQuery<K,SN,N> createMultigetSuperSliceCounterQuery(Keyspace keyspace,
                                                                                   Serializer<K> keySerializer,
                                                                                   Serializer<SN> sNameSerializer,
                                                                                   Serializer<N> nameSerializer)

createMultigetSubSliceQuery

public static <K,SN,N,V> MultigetSubSliceQuery<K,SN,N,V> createMultigetSubSliceQuery(Keyspace keyspace,
                                                                     Serializer<K> keySerializer,
                                                                     Serializer<SN> sNameSerializer,
                                                                     Serializer<N> nameSerializer,
                                                                     Serializer<V> valueSerializer)

createRangeSlicesQuery

public static <K,N,V> RangeSlicesQuery<K,N,V> createRangeSlicesQuery(Keyspace keyspace,
                                                     Serializer<K> keySerializer,
                                                     Serializer<N> nameSerializer,
                                                     Serializer<V> valueSerializer)

createRangeSlicesCounterQuery

public static <K,N> RangeSlicesCounterQuery<K,N> createRangeSlicesCounterQuery(Keyspace keyspace,
                                                               Serializer<K> keySerializer,
                                                               Serializer<N> nameSerializer)

createRangeSuperSlicesQuery

public static <K,SN,N,V> RangeSuperSlicesQuery<K,SN,N,V> createRangeSuperSlicesQuery(Keyspace keyspace,
                                                                     Serializer<K> keySerializer,
                                                                     Serializer<SN> sNameSerializer,
                                                                     Serializer<N> nameSerializer,
                                                                     Serializer<V> valueSerializer)

createRangeSuperSlicesCounterQuery

public static <K,SN,N> RangeSuperSlicesCounterQuery<K,SN,N> createRangeSuperSlicesCounterQuery(Keyspace keyspace,
                                                                               Serializer<K> keySerializer,
                                                                               Serializer<SN> sNameSerializer,
                                                                               Serializer<N> nameSerializer)

createIndexedSlicesQuery

@Deprecated
public static <K,N,V> IndexedSlicesQuery<K,N,V> createIndexedSlicesQuery(Keyspace keyspace,
                                                                    Serializer<K> keySerializer,
                                                                    Serializer<N> nameSerializer,
                                                                    Serializer<V> valueSerializer)

Deprecated.

This method will soon be removed. Please use createRangeSlicesQuery(Keyspace, Serializer, Serializer, Serializer) instead.

createRangeSubSlicesQuery

public static <K,SN,N,V> RangeSubSlicesQuery<K,SN,N,V> createRangeSubSlicesQuery(Keyspace keyspace,
                                                                 Serializer<K> keySerializer,
                                                                 Serializer<SN> sNameSerializer,
                                                                 Serializer<N> nameSerializer,
                                                                 Serializer<V> valueSerializer)

createRangeSubSlicesCounterQuery

public static <K,SN,N> RangeSubSlicesCounterQuery<K,SN,N> createRangeSubSlicesCounterQuery(Keyspace keyspace,
                                                                           Serializer<K> keySerializer,
                                                                           Serializer<SN> sNameSerializer,
                                                                           Serializer<N> nameSerializer)

createSliceQuery

public static <K,N,V> SliceQuery<K,N,V> createSliceQuery(Keyspace keyspace,
                                         Serializer<K> keySerializer,
                                         Serializer<N> nameSerializer,
                                         Serializer<V> valueSerializer)

createCounterSliceQuery

public static <K,N> SliceCounterQuery<K,N> createCounterSliceQuery(Keyspace keyspace,
                                                   Serializer<K> keySerializer,
                                                   Serializer<N> nameSerializer)

createSubSliceQuery

public static <K,SN,N,V> SubSliceQuery<K,SN,N,V> createSubSliceQuery(Keyspace keyspace,
                                                     Serializer<K> keySerializer,
                                                     Serializer<SN> sNameSerializer,
                                                     Serializer<N> nameSerializer,
                                                     Serializer<V> valueSerializer)

createSubSliceCounterQuery

public static <K,SN,N> SubSliceCounterQuery<K,SN,N> createSubSliceCounterQuery(Keyspace keyspace,
                                                               Serializer<K> keySerializer,
                                                               Serializer<SN> sNameSerializer,
                                                               Serializer<N> nameSerializer)

createSuperSliceQuery

public static <K,SN,N,V> SuperSliceQuery<K,SN,N,V> createSuperSliceQuery(Keyspace keyspace,
                                                         Serializer<K> keySerializer,
                                                         Serializer<SN> sNameSerializer,
                                                         Serializer<N> nameSerializer,
                                                         Serializer<V> valueSerializer)

createSuperColumn

public static <SN,N,V> HSuperColumn<SN,N,V> createSuperColumn(SN name,
                                              List<HColumn<N,V>> columns,
                                              Serializer<SN> superNameSerializer,
                                              Serializer<N> nameSerializer,
                                              Serializer<V> valueSerializer)

createSuperColumn accepts a variable number of column arguments

Parameters:: name - supercolumn name; columns -; superNameSerializer -; nameSerializer -; valueSerializer -
Returns:

createSuperColumn

public static <SN,N,V> HSuperColumn<SN,N,V> createSuperColumn(SN name,
                                              List<HColumn<N,V>> columns,
                                              long clock,
                                              Serializer<SN> superNameSerializer,
                                              Serializer<N> nameSerializer,
                                              Serializer<V> valueSerializer)

createCounterSuperColumn

public static <SN,N> HCounterSuperColumn<SN,N> createCounterSuperColumn(SN name,
                                                        List<HCounterColumn<N>> columns,
                                                        Serializer<SN> superNameSerializer,
                                                        Serializer<N> nameSerializer)

createColumn

public static <N,V> HColumn<N,V> createColumn(N name,
                              V value,
                              long clock,
                              Serializer<N> nameSerializer,
                              Serializer<V> valueSerializer)

Creates a column with a user-specified clock. You probably want to pass in Keyspace.createClock() for the value.

createColumn

public static <N,V> HColumn<N,V> createColumn(N name,
                              V value,
                              long clock)

Creates a column without specifying serializers.

createColumn

public static <N,V> HColumn<N,V> createColumn(N name,
                              V value)

Creates a column without specifying serializers.

createColumn

public static <N,V> HColumn<N,V> createColumn(N name,
                              V value,
                              long clock,
                              int ttl,
                              Serializer<N> nameSerializer,
                              Serializer<V> valueSerializer)

Create a column with a user-defined clock and TTL (DEFINED IN SECONDS SINCE THE TIMESTAMP [aka "clock"]). You probably want to use Keyspace.createClock() for the clock

createColumn

public static <N,V> HColumn<N,V> createColumn(N name,
                              V value,
                              Serializer<N> nameSerializer,
                              Serializer<V> valueSerializer)

Creates a column with the clock as defined by createClock() If you want to define a clock explicitly, use one of the overloaded forms below which take a clock, and call Keyspace.createClock()

createColumn

public static <N,V> HColumn<N,V> createColumn(N name,
                              V value,
                              int ttl,
                              Serializer<N> nameSerializer,
                              Serializer<V> valueSerializer)

Similar to the four argument version (including the clock creation) except we accept a TTL (DEFINED IN SECONDS SINCE THE TIMESTAMP [aka "clock"])

createStringColumn

public static HColumn<String,String> createStringColumn(String name,
                                        String value)

Convienience method for creating a column with a String name and String value

createCounterColumn

public static <N> HCounterColumn<N> createCounterColumn(N name,
                                        long value,
                                        Serializer<N> nameSerializer)

Create a counter column with a name and long value

createCounterColumn

public static HCounterColumn<String> createCounterColumn(String name,
                                         long value)

Convenient method for creating a counter column with a String name and long value

createClock
```
public static long createClock()
```
Creates a clock of now with the default clock resolution (micorosec) as defined in CassandraHostConfigurator. Notice that this is a convenience method. To specify explicit time, Keyspace.createClock() should be used instead.

createKeyspaceDefinition
```
public static KeyspaceDefinition createKeyspaceDefinition(String keyspace)
```
Use createKeyspaceDefinition to add a new Keyspace to cluster. Example: String testKeyspace = "testKeyspace"; KeyspaceDefinition newKeyspace = HFactory.createKeyspaceDefinition(testKeyspace); cluster.addKeyspace(newKeyspace);

Parameters:
keyspace -

createKeyspaceDefinition
```
public static KeyspaceDefinition createKeyspaceDefinition(String keyspaceName,
                                          String strategyClass,
                                          int replicationFactor,
                                          List<ColumnFamilyDefinition> cfDefs)
```
Use createKeyspaceDefinition to add a new Keyspace to cluster. Example: String testKeyspace = "testKeyspace"; KeyspaceDefinition newKeyspace = HFactory.createKeyspaceDefinition(testKeyspace); cluster.addKeyspace(newKeyspace);

Parameters:
keyspaceName -
strategyClass - - example: org.apache.cassandra.locator.SimpleStrategy.class.getName()
replicationFactor - - http://wiki.apache.org/cassandra/Operations

createColumnFamilyDefinition
```
public static ColumnFamilyDefinition createColumnFamilyDefinition(String keyspace,
                                                  String cfName)
```
Create a column family for a given keyspace without comparator type. Example: String keyspace = "testKeyspace"; String column1 = "testcolumn"; ColumnFamilyDefinition columnFamily1 = HFactory.createColumnFamilyDefinition(keyspace, column1); List columns = new ArrayList(); columns.add(columnFamily1); KeyspaceDefinition testKeyspace = HFactory.createKeyspaceDefinition(keyspace, org.apache.cassandra.locator.SimpleStrategy.class.getName(), 1, columns); cluster.addKeyspace(testKeyspace);

Parameters:
keyspace -
cfName -

createColumnFamilyDefinition
```
public static ColumnFamilyDefinition createColumnFamilyDefinition(String keyspace,
                                                  String cfName,
                                                  ComparatorType comparatorType)
```
Create a column family for a given keyspace without comparator type. Example: String keyspace = "testKeyspace"; String column1 = "testcolumn"; ColumnFamilyDefinition columnFamily1 = HFactory.createColumnFamilyDefinition(keyspace, column1, ComparatorType.UTF8TYPE); List columns = new ArrayList(); columns.add(columnFamily1); KeyspaceDefinition testKeyspace = HFactory.createKeyspaceDefinition(keyspace, org.apache.cassandra.locator.SimpleStrategy.class.getName(), 1, columns); cluster.addKeyspace(testKeyspace);

Parameters:
keyspace -
cfName -
comparatorType -

createColumnFamilyDefinition

public static ColumnFamilyDefinition createColumnFamilyDefinition(String keyspace,
                                                  String cfName,
                                                  ComparatorType comparatorType,
                                                  List<ColumnDefinition> columnMetadata)

createClockResolution
```
public static ClockResolution createClockResolution(String clockResolutionName)
```
Create a clock resolution based on clockResolutionName which has to match any of the constants defined at ClockResolution

Parameters:
clockResolutionName - type of clock resolution to create

Returns:
a ClockResolution

Class HFactory

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HFactory

Method Detail

getCluster

getOrCreateCluster

getOrCreateCluster

getOrCreateCluster

createCluster

createCluster

setClusterForTest

shutdownCluster

createKeyspace

createKeyspace

createKeyspace

createKeyspace

createVirtualKeyspace

createVirtualKeyspace

createVirtualKeyspace

createVirtualKeyspace

createDefaultConsistencyLevelPolicy

createMutator

createMutator

createColumnQuery

createCounterColumnQuery

createCountQuery

createSuperCountQuery

createSubCountQuery

createStringColumnQuery

createSuperColumnQuery

createMultigetSliceQuery

createMultigetSliceCounterQuery

createSuperSliceCounterQuery

createSubColumnQuery

createMultigetSuperSliceQuery

createMultigetSuperSliceCounterQuery

createMultigetSubSliceQuery

createRangeSlicesQuery

createRangeSlicesCounterQuery

createRangeSuperSlicesQuery

createRangeSuperSlicesCounterQuery

createIndexedSlicesQuery

createRangeSubSlicesQuery

createRangeSubSlicesCounterQuery

createSliceQuery

createCounterSliceQuery

createSubSliceQuery

createSubSliceCounterQuery

createSuperSliceQuery

createSuperColumn

createSuperColumn

createCounterSuperColumn

createColumn

createColumn

createColumn

createColumn

createColumn

createColumn

createStringColumn

createCounterColumn

createCounterColumn

createClock

createKeyspaceDefinition

createKeyspaceDefinition

createColumnFamilyDefinition

createColumnFamilyDefinition

createColumnFamilyDefinition

createClockResolution