ClusterSchema (PDI Engine 9.2.0.0-288 API)

java.lang.Object
- org.pentaho.di.core.changed.ChangedFlag
- - org.pentaho.di.cluster.ClusterSchema

All Implemented Interfaces:

Cloneable, ChangedFlagInterface, VariableSpace, XMLInterface, RepositoryElementInterface, RepositoryObjectInterface, SharedObjectInterface
```
public class ClusterSchema
extends ChangedFlag
implements Cloneable, SharedObjectInterface, VariableSpace, RepositoryElementInterface, XMLInterface
```
A cluster schema combines a list of slave servers so that they can be set altogether. It (can) also contain a number of performance tuning options regarding this cluster. For example options regarding communications with the master node of the nodes themselves come to mind.

Since:

17-nov-2006

Author:

Matt

Field Summary

Fields
Modifier and Type Field and Description

static RepositoryObjectType REPOSITORY_ELEMENT_TYPE

static String XML_TAG

Fields
Modifier and Type	Field and Description
`static RepositoryObjectType`	`REPOSITORY_ELEMENT_TYPE`
`static String`	`XML_TAG`

Constructor Summary

Constructors
Constructor and Description
`ClusterSchema()`
`ClusterSchema(Node clusterSchemaNode, List<SlaveServer> referenceSlaveServers)`
`ClusterSchema(String name, List<SlaveServer> slaveServers)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ClusterSchema`	`clone()`
`void`	`copyVariablesFrom(VariableSpace space)`
`String`	`environmentSubstitute(String aString)`
`String[]`	`environmentSubstitute(String[] aString)`
`boolean`	`equals(Object obj)`
`String`	`fieldSubstitute(String aString, RowMetaInterface rowMeta, Object[] rowData)`
`SlaveServer`	`findMaster()`
`int`	`findNrSlaves()`
`SlaveServer`	`findSlaveServer(String slaveServerName)`
`String`	`getBasePort()`
`boolean`	`getBooleanValueOfVariable(String variableName, boolean defaultValue)`
`Date`	`getChangedDate()`
`String`	`getDescription()`
`String`	`getName()`
`ObjectId`	`getObjectId()`
`ObjectRevision`	`getObjectRevision()`
`VariableSpace`	`getParentVariableSpace()`
`RepositoryDirectoryInterface`	`getRepositoryDirectory()` Not supported for Partition schema, return the root.
`RepositoryObjectType`	`getRepositoryElementType()`
`List<SlaveServer>`	`getSlaveServers()`
`List<SlaveServer>`	`getSlaveServersFromMasterOrLocal()`
`String[]`	`getSlaveServerStrings()`
`String`	`getSocketsBufferSize()`
`String`	`getSocketsFlushInterval()`
`String`	`getVariable(String variableName)`
`String`	`getVariable(String variableName, String defaultValue)`
`String`	`getXML()`
`int`	`hashCode()`
`void`	`initializeVariablesFrom(VariableSpace parent)`
`void`	`injectVariables(Map<String,String> prop)`
`boolean`	`isDynamic()`
`boolean`	`isShared()`
`boolean`	`isSocketsCompressed()`
`String[]`	`listVariables()`
`void`	`replaceMeta(ClusterSchema clusterSchema)`
`void`	`setBasePort(String basePort)`
`void`	`setChangedDate(Date changedDate)`
`void`	`setDescription(String description)`
`void`	`setDynamic(boolean dynamic)`
`void`	`setName(String name)`
`void`	`setObjectId(ObjectId id)`
`void`	`setObjectRevision(ObjectRevision objectRevision)`
`void`	`setParentVariableSpace(VariableSpace parent)`
`void`	`setRepositoryDirectory(RepositoryDirectoryInterface repositoryDirectory)`
`void`	`setShared(boolean shared)`
`void`	`setSlaveServers(List<SlaveServer> slaveServers)`
`void`	`setSocketsBufferSize(String socketsBufferSize)`
`void`	`setSocketsCompressed(boolean socketsCompressed)`
`void`	`setSocketsFlushInterval(String socketFlushInterval)`
`void`	`setVariable(String variableName, String variableValue)`
`void`	`shareVariablesWith(VariableSpace space)`
`String`	`toString()`

Methods inherited from class org.pentaho.di.core.changed.ChangedFlag
addObserver, clearChanged, deleteObserver, hasChanged, notifyObservers, setChanged, setChanged

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.pentaho.di.core.variables.VariableSpace
environmentSubstitute

- Field Detail
  - XML_TAG
```
public static final String XML_TAG
```
    See Also:
    
    Constant Field Values
  - REPOSITORY_ELEMENT_TYPE
```
public static final RepositoryObjectType REPOSITORY_ELEMENT_TYPE
```
- Constructor Detail
  - ClusterSchema
```
public ClusterSchema()
```
  - ClusterSchema
```
public ClusterSchema(String name,
                     List<SlaveServer> slaveServers)
```
    Parameters:
    
    name -
    
    slaveServers -
  - ClusterSchema
```
public ClusterSchema(Node clusterSchemaNode,
                     List<SlaveServer> referenceSlaveServers)
```
- Method Detail
  - clone
```
public ClusterSchema clone()
```
    Overrides:
    
    clone in class Object
  - replaceMeta
```
public void replaceMeta(ClusterSchema clusterSchema)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getXML
```
public String getXML()
```
    Specified by:
    
    getXML in interface XMLInterface
    
    Specified by:
    
    getXML in interface SharedObjectInterface
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface RepositoryElementInterface
    
    Specified by:
    
    getName in interface RepositoryObjectInterface
    
    Specified by:
    
    getName in interface SharedObjectInterface
    
    Returns:
    
    the name
  - setName
```
public void setName(String name)
```
    Specified by:
    
    setName in interface RepositoryElementInterface
    
    Parameters:
    
    name - the name to set
  - getSlaveServers
```
public List<SlaveServer> getSlaveServers()
```
    Returns:
    
    the internal (static) list of slave servers
  - setSlaveServers
```
public void setSlaveServers(List<SlaveServer> slaveServers)
```
    Parameters:
    
    slaveServers - the slaveServers to set
  - getSlaveServerStrings
```
public String[] getSlaveServerStrings()
```
    Returns:
    
    The slave server strings from this cluster schema
  - isShared
```
public boolean isShared()
```
    Specified by:
    
    isShared in interface SharedObjectInterface
    
    Returns:
    
    the shared
  - setShared
```
public void setShared(boolean shared)
```
    Specified by:
    
    setShared in interface SharedObjectInterface
    
    Parameters:
    
    shared - the shared to set
  - getBasePort
```
public String getBasePort()
```
    Returns:
    
    the basePort
  - setBasePort
```
public void setBasePort(String basePort)
```
    Parameters:
    
    basePort - the basePort to set
  - findMaster
```
public SlaveServer findMaster()
                       throws KettleException
```
    Throws:
    
    KettleException
  - findNrSlaves
```
public int findNrSlaves()
```
    Returns:
    
    The number of slave servers, excluding the master server
  - getSocketsFlushInterval
```
public String getSocketsFlushInterval()
```
    Returns:
    
    the socketFlushInterval
  - setSocketsFlushInterval
```
public void setSocketsFlushInterval(String socketFlushInterval)
```
    Parameters:
    
    socketFlushInterval - the socketFlushInterval to set
  - getSocketsBufferSize
```
public String getSocketsBufferSize()
```
    Returns:
    
    the socketsBufferSize
  - setSocketsBufferSize
```
public void setSocketsBufferSize(String socketsBufferSize)
```
    Parameters:
    
    socketsBufferSize - the socketsBufferSize to set
  - isSocketsCompressed
```
public boolean isSocketsCompressed()
```
    Returns:
    
    the socketsCompressed
  - setSocketsCompressed
```
public void setSocketsCompressed(boolean socketsCompressed)
```
    Parameters:
    
    socketsCompressed - the socketsCompressed to set
  - findSlaveServer
```
public SlaveServer findSlaveServer(String slaveServerName)
```
  - getObjectId
```
public ObjectId getObjectId()
```
    Specified by:
    
    getObjectId in interface RepositoryElementInterface
    
    Specified by:
    
    getObjectId in interface RepositoryObjectInterface
  - setObjectId
```
public void setObjectId(ObjectId id)
```
    Specified by:
    
    setObjectId in interface RepositoryElementInterface
  - copyVariablesFrom
```
public void copyVariablesFrom(VariableSpace space)
```
    Specified by:
    
    copyVariablesFrom in interface VariableSpace
  - environmentSubstitute
```
public String environmentSubstitute(String aString)
```
    Specified by:
    
    environmentSubstitute in interface VariableSpace
  - environmentSubstitute
```
public String[] environmentSubstitute(String[] aString)
```
    Specified by:
    
    environmentSubstitute in interface VariableSpace
  - fieldSubstitute
```
public String fieldSubstitute(String aString,
                              RowMetaInterface rowMeta,
                              Object[] rowData)
                       throws KettleValueException
```
    Specified by:
    
    fieldSubstitute in interface VariableSpace
    
    Throws:
    
    KettleValueException
  - getParentVariableSpace
```
public VariableSpace getParentVariableSpace()
```
    Specified by:
    
    getParentVariableSpace in interface VariableSpace
  - setParentVariableSpace
```
public void setParentVariableSpace(VariableSpace parent)
```
    Specified by:
    
    setParentVariableSpace in interface VariableSpace
  - getVariable
```
public String getVariable(String variableName,
                          String defaultValue)
```
    Specified by:
    
    getVariable in interface VariableSpace
  - getVariable
```
public String getVariable(String variableName)
```
    Specified by:
    
    getVariable in interface VariableSpace
  - getBooleanValueOfVariable
```
public boolean getBooleanValueOfVariable(String variableName,
                                         boolean defaultValue)
```
    Specified by:
    
    getBooleanValueOfVariable in interface VariableSpace
  - initializeVariablesFrom
```
public void initializeVariablesFrom(VariableSpace parent)
```
    Specified by:
    
    initializeVariablesFrom in interface VariableSpace
  - listVariables
```
public String[] listVariables()
```
    Specified by:
    
    listVariables in interface VariableSpace
  - setVariable
```
public void setVariable(String variableName,
                        String variableValue)
```
    Specified by:
    
    setVariable in interface VariableSpace
  - shareVariablesWith
```
public void shareVariablesWith(VariableSpace space)
```
    Specified by:
    
    shareVariablesWith in interface VariableSpace
  - injectVariables
```
public void injectVariables(Map<String,String> prop)
```
    Specified by:
    
    injectVariables in interface VariableSpace
  - isDynamic
```
public boolean isDynamic()
```
    Returns:
    
    the dynamic
  - setDynamic
```
public void setDynamic(boolean dynamic)
```
    Parameters:
    
    dynamic - the dynamic to set
  - getSlaveServersFromMasterOrLocal
```
public List<SlaveServer> getSlaveServersFromMasterOrLocal()
                                                   throws KettleException
```
    Returns:
    
    A list of dynamic slave servers, retrieved from the first master server that was available.
    
    Throws:
    
    KettleException - when none of the masters can be contacted.
  - getRepositoryDirectory
```
public RepositoryDirectoryInterface getRepositoryDirectory()
```
    Not supported for Partition schema, return the root.
    
    Specified by:
    
    getRepositoryDirectory in interface RepositoryElementInterface
  - setRepositoryDirectory
```
public void setRepositoryDirectory(RepositoryDirectoryInterface repositoryDirectory)
```
    Specified by:
    
    setRepositoryDirectory in interface RepositoryElementInterface
  - getRepositoryElementType
```
public RepositoryObjectType getRepositoryElementType()
```
    Specified by:
    
    getRepositoryElementType in interface RepositoryElementInterface
  - getObjectRevision
```
public ObjectRevision getObjectRevision()
```
    Specified by:
    
    getObjectRevision in interface RepositoryElementInterface
  - setObjectRevision
```
public void setObjectRevision(ObjectRevision objectRevision)
```
    Specified by:
    
    setObjectRevision in interface RepositoryElementInterface
  - getDescription
```
public String getDescription()
```
    Specified by:
    
    getDescription in interface RepositoryElementInterface
  - setDescription
```
public void setDescription(String description)
```
    Specified by:
    
    setDescription in interface RepositoryElementInterface
  - getChangedDate
```
public Date getChangedDate()
```
    Specified by:
    
    getChangedDate in interface SharedObjectInterface
    
    Returns:
    
    the changedDate
  - setChangedDate
```
public void setChangedDate(Date changedDate)
```
    Parameters:
    
    changedDate - the changedDate to set

Class ClusterSchema

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.pentaho.di.core.changed.ChangedFlag

Methods inherited from class java.lang.Object

Methods inherited from interface org.pentaho.di.core.variables.VariableSpace

Field Detail

XML_TAG

REPOSITORY_ELEMENT_TYPE

Constructor Detail

ClusterSchema

ClusterSchema

ClusterSchema

Method Detail

clone

replaceMeta

toString

equals

hashCode

getXML

getName

setName

getSlaveServers

setSlaveServers

getSlaveServerStrings

isShared

setShared

getBasePort

setBasePort

findMaster

findNrSlaves

getSocketsFlushInterval

setSocketsFlushInterval

getSocketsBufferSize

setSocketsBufferSize

isSocketsCompressed

setSocketsCompressed

findSlaveServer

getObjectId

setObjectId

copyVariablesFrom

environmentSubstitute

environmentSubstitute

fieldSubstitute

getParentVariableSpace

setParentVariableSpace

getVariable

getVariable

getBooleanValueOfVariable

initializeVariablesFrom

listVariables

setVariable

shareVariablesWith

injectVariables

isDynamic

setDynamic

getSlaveServersFromMasterOrLocal

getRepositoryDirectory

setRepositoryDirectory

getRepositoryElementType

getObjectRevision

setObjectRevision

getDescription

setDescription

getChangedDate

setChangedDate