org.apache.accumulo.core.client.impl
Class TableOperationsHelper

java.lang.Object
  org.apache.accumulo.core.client.impl.TableOperationsHelper

All Implemented Interfaces:

TableOperations

Direct Known Subclasses:

MockTableOperations, TableOperationsHelper, TableOperationsImpl

public abstract class TableOperationsHelper
extends Object
implements TableOperations

Constructor Summary

TableOperationsHelper()

Method Summary

int	addConstraint(String tableName, String constraintClassName) Add a new constraint to a table.
void	attachIterator(String tableName, IteratorSetting setting) Add an iterator to a table on all scopes.
void	attachIterator(String tableName, IteratorSetting setting, EnumSet<IteratorUtil.IteratorScope> scopes) Add an iterator to a table on the given scopes.
void	checkIteratorConflicts(String tableName, IteratorSetting setting, EnumSet<IteratorUtil.IteratorScope> scopes) Check whether a given iterator configuration conflicts with existing configuration; in particular, determine if the name or priority are already in use for the specified scopes.
IteratorSetting	getIteratorSetting(String tableName, String name, IteratorUtil.IteratorScope scope) Get the settings for an iterator.
Map<String,Integer>	listConstraints(String tableName) List constraints on a table with their assigned numbers.
Map<String,EnumSet<IteratorUtil.IteratorScope>>	listIterators(String tableName) Get a list of iterators for this table.
void	removeConstraint(String tableName, int number) Remove a constraint from a table.
void	removeIterator(String tableName, String name, EnumSet<IteratorUtil.IteratorScope> scopes) Remove an iterator from a table by name.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.accumulo.core.client.admin.TableOperations

addSplits, cancelCompaction, clearLocatorCache, clone, compact, compact, create, create, create, delete, deleteRows, exists, exportTable, flush, flush, getDiskUsage, getLocalityGroups, getMaxRow, getProperties, getSplits, getSplits, importDirectory, importTable, list, listSplits, listSplits, merge, offline, offline, online, online, removeProperty, rename, setLocalityGroups, setProperty, splitRangeByTablets, tableIdMap, testClassLoad

Constructor Detail

TableOperationsHelper

public TableOperationsHelper()

Method Detail

attachIterator

public void attachIterator(String tableName,
                           IteratorSetting setting)
                    throws AccumuloSecurityException,
                           AccumuloException,
                           TableNotFoundException

Description copied from interface: TableOperations

Add an iterator to a table on all scopes.

Specified by:

attachIterator in interface TableOperations

Parameters:

tableName - the name of the table

setting - object specifying the properties of the iterator

Throws:

AccumuloSecurityException - thrown if the user does not have the ability to set properties on the table

TableNotFoundException - throw if the table no longer exists

AccumuloException

attachIterator

public void attachIterator(String tableName,
                           IteratorSetting setting,
                           EnumSet<IteratorUtil.IteratorScope> scopes)
                    throws AccumuloSecurityException,
                           AccumuloException,
                           TableNotFoundException

Description copied from interface: TableOperations

Add an iterator to a table on the given scopes.

Specified by:

attachIterator in interface TableOperations

Parameters:

tableName - the name of the table

setting - object specifying the properties of the iterator

Throws:

AccumuloSecurityException - thrown if the user does not have the ability to set properties on the table

TableNotFoundException - throw if the table no longer exists

AccumuloException

removeIterator

public void removeIterator(String tableName,
                           String name,
                           EnumSet<IteratorUtil.IteratorScope> scopes)
                    throws AccumuloSecurityException,
                           AccumuloException,
                           TableNotFoundException

Description copied from interface: TableOperations

Remove an iterator from a table by name.

Specified by:

removeIterator in interface TableOperations

Parameters:

tableName - the name of the table

name - the name of the iterator

scopes - the scopes of the iterator

Throws:

AccumuloSecurityException - thrown if the user does not have the ability to set properties on the table

TableNotFoundException - throw if the table no longer exists

AccumuloException

getIteratorSetting

public IteratorSetting getIteratorSetting(String tableName,
                                          String name,
                                          IteratorUtil.IteratorScope scope)
                                   throws AccumuloSecurityException,
                                          AccumuloException,
                                          TableNotFoundException

Description copied from interface: TableOperations

Get the settings for an iterator.

Specified by:

getIteratorSetting in interface TableOperations

Parameters:

tableName - the name of the table

name - the name of the iterator

scope - the scope of the iterator

Returns:

the settings for this iterator

Throws:

AccumuloSecurityException - thrown if the user does not have the ability to set properties on the table

TableNotFoundException - throw if the table no longer exists

AccumuloException

listIterators

public Map<String,EnumSet<IteratorUtil.IteratorScope>> listIterators(String tableName)
                                                              throws AccumuloSecurityException,
                                                                     AccumuloException,
                                                                     TableNotFoundException

Description copied from interface: TableOperations

Get a list of iterators for this table.

Specified by:

listIterators in interface TableOperations

Parameters:

tableName - the name of the table

Returns:

a set of iterator names

Throws:

AccumuloSecurityException

AccumuloException

TableNotFoundException

checkIteratorConflicts

public void checkIteratorConflicts(String tableName,
                                   IteratorSetting setting,
                                   EnumSet<IteratorUtil.IteratorScope> scopes)
                            throws AccumuloException,
                                   TableNotFoundException

Description copied from interface: TableOperations

Check whether a given iterator configuration conflicts with existing configuration; in particular, determine if the name or priority are already in use for the specified scopes.

Specified by:

checkIteratorConflicts in interface TableOperations

Parameters:

tableName - the name of the table

setting - object specifying the properties of the iterator

Throws:

AccumuloException

TableNotFoundException

addConstraint

public int addConstraint(String tableName,
                         String constraintClassName)
                  throws AccumuloException,
                         AccumuloSecurityException,
                         TableNotFoundException

Description copied from interface: TableOperations

Add a new constraint to a table.

Specified by:

addConstraint in interface TableOperations

Parameters:

tableName - the name of the table

constraintClassName - the full name of the constraint class

Returns:

the unique number assigned to the constraint

Throws:

AccumuloException - thrown if the constraint has already been added to the table or if there are errors in the configuration of existing constraints

AccumuloSecurityException - thrown if the user doesn't have permission to add the constraint

TableNotFoundException

removeConstraint

public void removeConstraint(String tableName,
                             int number)
                      throws AccumuloException,
                             AccumuloSecurityException

Description copied from interface: TableOperations

Remove a constraint from a table.

Specified by:

removeConstraint in interface TableOperations

Parameters:

tableName - the name of the table

number - the unique number assigned to the constraint

Throws:

AccumuloSecurityException - thrown if the user doesn't have permission to remove the constraint

AccumuloException

listConstraints

public Map<String,Integer> listConstraints(String tableName)
                                    throws AccumuloException,
                                           TableNotFoundException

Description copied from interface: TableOperations

List constraints on a table with their assigned numbers.

Specified by:

listConstraints in interface TableOperations

Parameters:

tableName - the name of the table

Returns:

a map from constraint class name to assigned number

Throws:

AccumuloException - thrown if there are errors in the configuration of existing constraints

TableNotFoundException