Package org.apache.accumulo.core.iterators

Class OptionDescriber.IteratorOptions

java.lang.Object

org.apache.accumulo.core.iterators.OptionDescriber.IteratorOptions

Enclosing interface:

OptionDescriber

public static class OptionDescriber.IteratorOptions
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
String	description
String	name
LinkedHashMap<String,String>	namedOptions
ArrayList<String>	unnamedOptionDescriptions

Constructor Summary

Constructors

Constructor	Description
IteratorOptions(String name, String description, Map<String,String> namedOptions, List<String> unnamedOptionDescriptions)	IteratorOptions holds the name, description, and option information for an iterator.

Method Summary

Modifier and Type	Method	Description
void	addNamedOption(String name, String description)
void	addUnnamedOption(String description)
String	getDescription()
String	getName()
Map<String,String>	getNamedOptions()
List<String>	getUnnamedOptionDescriptions()
void	setDescription(String description)
void	setName(String name)
void	setNamedOptions(Map<String,String> namedOptions)
void	setUnnamedOptionDescriptions(List<String> unnamedOptionDescriptions)

Methods inherited from class java.lang.Object

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

Field Detail

namedOptions

public LinkedHashMap<String,String> namedOptions

unnamedOptionDescriptions

public ArrayList<String> unnamedOptionDescriptions

name

public String name

description

public String description

Constructor Detail

IteratorOptions

public IteratorOptions(String name,
                       String description,
                       Map<String,String> namedOptions,
                       List<String> unnamedOptionDescriptions)

IteratorOptions holds the name, description, and option information for an iterator.

Parameters:

name - is the distinguishing name for the iterator or filter

description - is a description of the iterator or filter

namedOptions - is a map from specifically named options to their descriptions (null if unused) e.g., the AgeOffFilter requires a parameter called "ttl", so its namedOptions = Collections.singletonMap("ttl", "time to live (milliseconds)")

unnamedOptionDescriptions - is a list of descriptions of additional options that don't have fixed names (null if unused). The descriptions are intended to describe a category, and the user will provide parameter names and values in that category; e.g., the FilteringIterator needs a list of Filters intended to be named by their priority numbers, so it's
unnamedOptionDescriptions = Collections
.singletonList("<filterPriorityNumber> <ageoff|regex|filterClass>")

Method Detail

getNamedOptions

public Map<String,String> getNamedOptions()

getUnnamedOptionDescriptions

public List<String> getUnnamedOptionDescriptions()

getName

public String getName()

getDescription

public String getDescription()

setNamedOptions

public void setNamedOptions(Map<String,String> namedOptions)

setUnnamedOptionDescriptions

public void setUnnamedOptionDescriptions(List<String> unnamedOptionDescriptions)

setName

public void setName(String name)

setDescription

public void setDescription(String description)

addNamedOption

public void addNamedOption(String name,
                           String description)

addUnnamedOption

public void addUnnamedOption(String description)