org.commonvox.hbase_column_manager

Class ChangeEventMonitor

Object

ChangeEventMonitor

public class ChangeEventMonitor
extends Object

A ChangeEventMonitor (obtained via a RepositoryAdmin's getChangeEventMonitor method) provides various get methods by which lists of ChangeEvents may be obtained (grouped and ordered in various ways), and the class provides a static convenience method for outputting a list of ChangeEvents to a CSV file.

Author:

Daniel Vimont

Method Summary

Modifier and Type	Method and Description
static void	exportChangeEventListToCsvFile(Collection<ChangeEvent> changeEvents, File targetFile) Export the submitted list of ChangeEvent objects to a comma-separated-value (CSV) file, one line per ChangeEvent, with the first non-comment line of the file consisting of column headers.
Set<ChangeEvent>	getAllChangeEvents() Get a Set of all ChangeEvents in the ColumnManager repository in the default (timestamp) order.
Set<ChangeEvent>	getAllChangeEventsByUserName() Get a Set of all ChangeEvents in the ColumnManager repository, ordered by user name (as designated by the Java "user.name" property in effect within a session as a change was made).
Set<ChangeEvent>	getChangeEventsForColumnAuditor(TableName tableName, byte[] columnFamily, byte[] columnQualifier) Get the ChangeEvents pertaining to the specified ColumnAuditor, in timestamp order.
Set<ChangeEvent>	getChangeEventsForColumnDefinition(TableName tableName, byte[] columnFamily, byte[] columnQualifier) Get the ChangeEvents pertaining to the specified ColumnDefinition, in timestamp order.
Set<ChangeEvent>	getChangeEventsForColumnFamily(TableName tableName, byte[] columnFamily, boolean includeChildEntities) Get the ChangeEvents pertaining to the specified Column Family, in timestamp order.
Set<ChangeEvent>	getChangeEventsForColumnFamilyAttribute(TableName tableName, byte[] columnFamily, String attributeName) Get the ChangeEvents pertaining to the specified Attribute of the specified Column Family, in timestamp order.
Set<ChangeEvent>	getChangeEventsForNamespace(byte[] namespaceName, boolean includeChildEntities) Get the ChangeEvents pertaining to the specified Namespace, in timestamp order.
Set<ChangeEvent>	getChangeEventsForTable(TableName tableName, boolean includeChildEntities) Get the ChangeEvents pertaining to the specified Table, in timestamp order.
Set<ChangeEvent>	getChangeEventsForTableAttribute(TableName tableName, String attributeName) Get the ChangeEvents pertaining to the specified Attribute of the specified Table, in timestamp order.
Set<ChangeEvent>	getChangeEventsForUserName(String userName) Get the ChangeEvents pertaining to a specific user name (as designated by the Java "user.name" property in effect within a session as a change was made), in timestamp order.

Methods inherited from class Object

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

Method Detail

getAllChangeEvents

public Set<ChangeEvent> getAllChangeEvents()

Get a Set of all ChangeEvents in the ColumnManager repository in the default (timestamp) order.

Returns:

complete list of ChangeEvents in timestamp order

getAllChangeEventsByUserName

public Set<ChangeEvent> getAllChangeEventsByUserName()

Get a Set of all ChangeEvents in the ColumnManager repository, ordered by user name (as designated by the Java "user.name" property in effect within a session as a change was made).

Returns:

complete list of ChangeEvents in user-name and timestamp order

getChangeEventsForUserName

public Set<ChangeEvent> getChangeEventsForUserName(String userName)

Get the ChangeEvents pertaining to a specific user name (as designated by the Java "user.name" property in effect within a session as a change was made), in timestamp order.

Parameters:

userName - value of Java "user.name" property in effect when change was made

Returns:

Set of ChangeEvents pertaining to the user name, in timestamp order

getChangeEventsForNamespace

public Set<ChangeEvent> getChangeEventsForNamespace(byte[] namespaceName,
                                                    boolean includeChildEntities)

Get the ChangeEvents pertaining to the specified Namespace, in timestamp order.

Parameters:

namespaceName - Namespace name

includeChildEntities - if true ChangeEvents for Tables and all table components in the Namespace will be included in returned Set

Returns:

Set of ChangeEvents pertaining to the specified Namespace

getChangeEventsForTable

public Set<ChangeEvent> getChangeEventsForTable(TableName tableName,
                                                boolean includeChildEntities)

Get the ChangeEvents pertaining to the specified Table, in timestamp order.

Parameters:

tableName - TableName object

includeChildEntities - if true ChangeEvents for Column Families, ColumnAuditors, and ColumnDefinitions will be included in returned Set

Returns:

Set of ChangeEvents pertaining to the specified Table

getChangeEventsForTableAttribute

public Set<ChangeEvent> getChangeEventsForTableAttribute(TableName tableName,
                                                         String attributeName)

Get the ChangeEvents pertaining to the specified Attribute of the specified Table, in timestamp order.

Parameters:

tableName - TableName object

attributeName - name of attribute

Returns:

Set of ChangeEvents pertaining to the specified Attribute of the specified Table

getChangeEventsForColumnFamily

public Set<ChangeEvent> getChangeEventsForColumnFamily(TableName tableName,
                                                       byte[] columnFamily,
                                                       boolean includeChildEntities)

Get the ChangeEvents pertaining to the specified Column Family, in timestamp order.

Parameters:

tableName - TableName object

columnFamily - name of Column Family

includeChildEntities - if true ChangeEvents for ColumnAuditors and ColumnDefinitions will be included in returned Set

Returns:

Set of ChangeEvents pertaining to the specified Column Family

getChangeEventsForColumnFamilyAttribute

public Set<ChangeEvent> getChangeEventsForColumnFamilyAttribute(TableName tableName,
                                                                byte[] columnFamily,
                                                                String attributeName)

Get the ChangeEvents pertaining to the specified Attribute of the specified Column Family, in timestamp order.

Parameters:

tableName - TableName object

columnFamily - name of Column Family

attributeName - name of attribute

Returns:

Set of ChangeEvents pertaining to the specified Attribute of the specified Column Family

getChangeEventsForColumnDefinition

public Set<ChangeEvent> getChangeEventsForColumnDefinition(TableName tableName,
                                                           byte[] columnFamily,
                                                           byte[] columnQualifier)

Get the ChangeEvents pertaining to the specified ColumnDefinition, in timestamp order.

Parameters:

tableName - TableName object

columnFamily - name of Column Family

columnQualifier - qualifier that identifies the ColumnDefinition

Returns:

Set of ChangeEvents pertaining to the specified ColumnDefinition

getChangeEventsForColumnAuditor

public Set<ChangeEvent> getChangeEventsForColumnAuditor(TableName tableName,
                                                        byte[] columnFamily,
                                                        byte[] columnQualifier)

Get the ChangeEvents pertaining to the specified ColumnAuditor, in timestamp order.

Parameters:

tableName - TableName object

columnFamily - name of Column Family

columnQualifier - qualifier that identifies the ColumnAuditor

Returns:

Set of ChangeEvents pertaining to the specified ColumnAuditor

exportChangeEventListToCsvFile

public static void exportChangeEventListToCsvFile(Collection<ChangeEvent> changeEvents,
                                                  File targetFile)
                                           throws IOException

Export the submitted list of ChangeEvent objects to a comma-separated-value (CSV) file, one line per ChangeEvent, with the first non-comment line of the file consisting of column headers.

Parameters:

changeEvents - list of ChangeEvent objects returned by one of the "get" methods of the ChangeEventMonitor class.

targetFile - target file

Throws:

IOException - if a remote or network exception occurs