org.pentaho.di.repository.keyvalue

Interface RepositoryKeyValueInterface

public interface RepositoryKeyValueInterface

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAMESPACE_DIMENSIONS
static String	NAMESPACE_VARIABLES

Method Summary

Modifier and Type	Method and Description
String	getValue(String namespace, String key, String revision) Load a value from the repository
List<String>	listKeys(String namespace) List the keys for a given name-space in the repository
List<String>	listNamespaces()
List<RepositoryValueInterface>	listValues(String namespace) This method lists the key/value entries for a given name-space.
void	putValue(String namespace, String key, String value) Store a value in the repository using the key/value interface
void	removeValue(String namespace, String key) Remove a value from the repository key/value store

Field Detail

NAMESPACE_VARIABLES

static final String NAMESPACE_VARIABLES

See Also:

Constant Field Values

NAMESPACE_DIMENSIONS

static final String NAMESPACE_DIMENSIONS

See Also:

Constant Field Values

Method Detail

putValue

void putValue(String namespace,
              String key,
              String value)
       throws org.pentaho.di.core.exception.KettleException

Store a value in the repository using the key/value interface

Parameters:

namespace - the name-space to reference

key - The key to use

value - The value to store

Throws:

org.pentaho.di.core.exception.KettleException - in case there is an unexpected repository error

removeValue

void removeValue(String namespace,
                 String key)
          throws org.pentaho.di.core.exception.KettleException

Remove a value from the repository key/value store

Parameters:

namespace - the name-space to reference

key - The key of the value to remove

Throws:

org.pentaho.di.core.exception.KettleException - in case there is an unexpected repository error

getValue

String getValue(String namespace,
                String key,
                String revision)
         throws org.pentaho.di.core.exception.KettleException

Load a value from the repository

Parameters:

namespace - The name-space to use

key - The key to look up

revision - The revision to use or null if you want the last revision (optionally supported)

Returns:

The value including name, description, ...

Throws:

org.pentaho.di.core.exception.KettleException - in case there is an unexpected repository error

listNamespaces

List<String> listNamespaces()
                     throws org.pentaho.di.core.exception.KettleException

Returns:

The list of name-spaces in the repository

Throws:

org.pentaho.di.core.exception.KettleException - in case there is an unexpected repository error

listKeys

List<String> listKeys(String namespace)
               throws org.pentaho.di.core.exception.KettleException

List the keys for a given name-space in the repository

Parameters:

namespace - The name-space to query

Returns:

The list of keys in the name-space

Throws:

org.pentaho.di.core.exception.KettleException - in case there is an unexpected repository error

listValues

List<RepositoryValueInterface> listValues(String namespace)
                                   throws org.pentaho.di.core.exception.KettleException

This method lists the key/value entries for a given name-space. Even though this method returns a RepositoryValueInterface it does NOT (need to) load the actual object mentioned in it.

Parameters:

namespace - The name-space to query

Returns:

A list of value entries, unsorted.

Throws:

org.pentaho.di.core.exception.KettleException - in case there is an unexpected repository error