org.pentaho.di.core.namedcluster

Class NamedClusterManager

java.lang.Object

org.pentaho.di.core.namedcluster.NamedClusterManager

public class NamedClusterManager
extends Object

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(String clusterName, org.pentaho.metastore.api.IMetaStore metastore) This method checks if the NamedCluster exists in the metastore
void	create(NamedCluster namedCluster, org.pentaho.metastore.api.IMetaStore metastore) Saves a named cluster in the provided IMetaStore
void	delete(String clusterName, org.pentaho.metastore.api.IMetaStore metastore) Deletes a NamedCluster from the provided IMetaStore
NamedCluster	getClusterTemplate() This method returns the named cluster template used to configure new NamedClusters.
static NamedClusterManager	getInstance()
List<NamedCluster>	list(org.pentaho.metastore.api.IMetaStore metastore) This method lists the NamedCluster in the given IMetaStore
List<String>	listNames(org.pentaho.metastore.api.IMetaStore metastore) This method returns the list of NamedCluster names in the IMetaStore
NamedCluster	read(String clusterName, org.pentaho.metastore.api.IMetaStore metastore) Reads a NamedCluster from the provided IMetaStore
void	setClusterTemplate(NamedCluster clusterTemplate) This method will set the cluster template used when creating new NamedClusters
void	update(NamedCluster namedCluster, org.pentaho.metastore.api.IMetaStore metastore) Updates a NamedCluster in the provided IMetaStore

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static NamedClusterManager getInstance()

getClusterTemplate

public NamedCluster getClusterTemplate()

This method returns the named cluster template used to configure new NamedClusters. Note that this method returns a clone (deep) of the template.

Returns:

the NamedCluster template

setClusterTemplate

public void setClusterTemplate(NamedCluster clusterTemplate)

This method will set the cluster template used when creating new NamedClusters

Parameters:

clusterTemplate - the NamedCluster template to set

create

public void create(NamedCluster namedCluster,
          org.pentaho.metastore.api.IMetaStore metastore)
            throws org.pentaho.metastore.api.exceptions.MetaStoreException

Saves a named cluster in the provided IMetaStore

Parameters:

namedCluster - the NamedCluster to save

metastore - the IMetaStore to operate with

Throws:

org.pentaho.metastore.api.exceptions.MetaStoreException

read

public NamedCluster read(String clusterName,
                org.pentaho.metastore.api.IMetaStore metastore)
                  throws org.pentaho.metastore.api.exceptions.MetaStoreException

Reads a NamedCluster from the provided IMetaStore

Parameters:

clusterName - the name of the NamedCluster to load

metastore - the IMetaStore to operate with

Returns:

the NamedCluster that was loaded

Throws:

org.pentaho.metastore.api.exceptions.MetaStoreException

update

public void update(NamedCluster namedCluster,
          org.pentaho.metastore.api.IMetaStore metastore)
            throws org.pentaho.metastore.api.exceptions.MetaStoreException

Updates a NamedCluster in the provided IMetaStore

Parameters:

namedCluster - the NamedCluster to update

metastore - the IMetaStore to operate with

Throws:

org.pentaho.metastore.api.exceptions.MetaStoreException

delete

public void delete(String clusterName,
          org.pentaho.metastore.api.IMetaStore metastore)
            throws org.pentaho.metastore.api.exceptions.MetaStoreException

Deletes a NamedCluster from the provided IMetaStore

Parameters:

clusterName - the NamedCluster to delete

metastore - the IMetaStore to operate with

Throws:

org.pentaho.metastore.api.exceptions.MetaStoreException

list

public List<NamedCluster> list(org.pentaho.metastore.api.IMetaStore metastore)
                        throws org.pentaho.metastore.api.exceptions.MetaStoreException

This method lists the NamedCluster in the given IMetaStore

Parameters:

metastore - the IMetaStore to operate with

Returns:

the list of NamedClusters in the provided IMetaStore

Throws:

org.pentaho.metastore.api.exceptions.MetaStoreException

listNames

public List<String> listNames(org.pentaho.metastore.api.IMetaStore metastore)
                       throws org.pentaho.metastore.api.exceptions.MetaStoreException

This method returns the list of NamedCluster names in the IMetaStore

Parameters:

metastore - the IMetaStore to operate with

Returns:

the list of NamedCluster names (Strings)

Throws:

org.pentaho.metastore.api.exceptions.MetaStoreException

contains

public boolean contains(String clusterName,
               org.pentaho.metastore.api.IMetaStore metastore)
                 throws org.pentaho.metastore.api.exceptions.MetaStoreException

This method checks if the NamedCluster exists in the metastore

Parameters:

clusterName - the name of the NamedCluster to check

metastore - the IMetaStore to operate with

Returns:

true if the NamedCluster exists in the given metastore

Throws:

org.pentaho.metastore.api.exceptions.MetaStoreException