Package org.apache.accumulo.core.client.summary

Class SummarizerConfiguration

java.lang.Object

org.apache.accumulo.core.client.summary.SummarizerConfiguration

public class SummarizerConfiguration
extends Object

This class encapsulates the configuration needed to instantiate a Summarizer. It also provides methods and documentation for setting the table properties that configure a Summarizer.

Since:

2.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SummarizerConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static SummarizerConfiguration.Builder	builder(Class<? extends Summarizer> clazz)
static SummarizerConfiguration.Builder	builder(String className)	Call this method to initiate a chain of fluent method calls to a create an immutable SummarizerConfiguration
boolean	equals(Object o)	Compares the classname and options to determine equality.
static Collection<SummarizerConfiguration>	fromTableProperties(Iterable<Map.Entry<String,String>> props)
static Collection<SummarizerConfiguration>	fromTableProperties(Map<String,String> props)	Decodes table properties with the prefix table.summarizer into SummarizerConfiguration objects.
String	getClassName()
Map<String,String>	getOptions()
String	getPropertyId()	The propertyId is used when creating table properties for a summarizer.
int	hashCode()	Hashes the classname and options to create a hashcode.
String	toString()
Map<String,String>	toTableProperties()	Converts this configuration to Accumulo per table properties.
static Map<String,String>	toTableProperties(Collection<SummarizerConfiguration> configurations)	Encodes each configuration in the same way as toTableProperties().
static Map<String,String>	toTableProperties(SummarizerConfiguration... configurations)	Encodes each configuration in the same way as toTableProperties().

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

getClassName

public String getClassName()

Returns:

the name of a class that implements @link Summarizer.

getOptions

public Map<String,String> getOptions()

Returns:

custom options for a {link @Summarizer}

getPropertyId

public String getPropertyId()

The propertyId is used when creating table properties for a summarizer. It's not used for equality or hashCode for this class.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Compares the classname and options to determine equality.

Overrides:

equals in class Object

hashCode

public int hashCode()

Hashes the classname and options to create a hashcode.

Overrides:

hashCode in class Object

toTableProperties

public Map<String,String> toTableProperties()

Converts this configuration to Accumulo per table properties. The returned map has the following key values. The <configId> below is from getPropertyId(). The <optionKey> and <optionValue> below are derived from the key values of getOptions().

 
   table.summarizer.<configId>=<classname>
   table.summarizer.<configId>.opt.<optionKey1>=<optionValue1>
   table.summarizer.<configId>.opt.<optionKey2>=<optionValue2>
      .
      .
      .
   table.summarizer.<configId>.opt.<optionKeyN>=<optionValueN>
 
 

toTableProperties

public static Map<String,String> toTableProperties(SummarizerConfiguration... configurations)

Encodes each configuration in the same way as toTableProperties().

Throws:

IllegalArgumentException - when there are duplicate values for getPropertyId()

toTableProperties

public static Map<String,String> toTableProperties(Collection<SummarizerConfiguration> configurations)

Encodes each configuration in the same way as toTableProperties().

Throws:

IllegalArgumentException - when there are duplicate values for getPropertyId()

fromTableProperties

public static Collection<SummarizerConfiguration> fromTableProperties(Map<String,String> props)

Decodes table properties with the prefix table.summarizer into SummarizerConfiguration objects. Table properties with prefixes other than table.summarizer are ignored.

fromTableProperties

public static Collection<SummarizerConfiguration> fromTableProperties(Iterable<Map.Entry<String,String>> props)

See Also:

• fromTableProperties(Map)

builder

public static SummarizerConfiguration.Builder builder(String className)

Call this method to initiate a chain of fluent method calls to a create an immutable SummarizerConfiguration

Parameters:

className - The fully qualified name of a class that implements Summarizer.

builder

public static SummarizerConfiguration.Builder builder(Class<? extends Summarizer> clazz)

See Also:

• builder(String)