com.bigdata.service

Class ListIndicesTask

java.lang.Object

com.bigdata.service.FederationCallable<T>

com.bigdata.service.DataServiceCallable<String[]>

com.bigdata.service.ListIndicesTask

All Implemented Interfaces:

IDataServiceCallable, IFederationCallable, Serializable, Callable<String[]>

public class ListIndicesTask
extends DataServiceCallable<String[]>

Task returns an array of the named indices on the DataService to which it is submitted. The array is in the visitation order for the index names (alpha, given the collator choices in force).

Note that MetadataService extends DataService so this task can also be used to enumerate the scale-out indices in an IBigdataFederation. However, when enumerating metadata index names, note that they all use a prefix to place them into their own namespace.

Version:

$Id$

Author:

Bryan Thompson

See Also:

MetadataService.METADATA_INDEX_NAMESPACE, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	INFO
protected static org.apache.log4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
ListIndicesTask(long ts, String namespace)

Method Summary

Methods

Modifier and Type	Method and Description
String[]	call()

Methods inherited from class com.bigdata.service.DataServiceCallable

getDataService, isDataService, setDataService

Methods inherited from class com.bigdata.service.FederationCallable

getFederation, setFederation

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.bigdata.service.IFederationCallable

getFederation, setFederation

Field Detail

log

protected static final transient org.apache.log4j.Logger log

INFO

protected static final transient boolean INFO

Constructor Detail

ListIndicesTask

public ListIndicesTask(long ts,
               String namespace)

Parameters:

ts - The timestamp for which the data will be reported.

namespace - The namespace prefix for the indices to be returned (may be an empty string to return the names of all registered indices).

Note: This SHOULD include a "." if you want to restrict the scan to only those indices in a given namespace. Otherwise you can find indices in kb2 if you provide the prefix kb and both kb and kb2 are namespaces since the indices spanned by kb would include both kb.xyz and kb2.xyx.

Method Detail

call

public String[] call()
              throws Exception

Throws:

Exception