org.pentaho.di.core.util
Class StringPluginProperty

java.lang.Object
  extended by org.pentaho.di.core.util.KeyValue<String>
      extended by org.pentaho.di.core.util.StringPluginProperty
All Implemented Interfaces:
Serializable, PluginProperty

public class StringPluginProperty
extends KeyValue<String>
implements PluginProperty

Author:
Thomas Hoedl(asc042)
See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.pentaho.di.core.util.KeyValue
DEFAULT_TRUE_VALUES, VALID_KEY_CHARS
 
Fields inherited from interface org.pentaho.di.core.util.PluginProperty
BOOLEAN_STRING_TRUE, DEFAULT_BOOLEAN_VALUE, DEFAULT_DOUBLE_VALUE, DEFAULT_INTEGER_VALUE, DEFAULT_STRING_VALUE
 
Constructor Summary
StringPluginProperty(String key)
          Constructor.
 
Method Summary
 void appendXml(StringBuilder builder)
          
 boolean evaluate()
          
 void loadXml(Node node)
          
 void readFromPreferences(Preferences node)
          
 void readFromRepositoryStep(Repository repository, ObjectId stepId)
          
 void saveToPreferences(Preferences node)
          
 void saveToRepositoryStep(Repository repository, ObjectId transformationId, ObjectId stepId)
          
 
Methods inherited from class org.pentaho.di.core.util.KeyValue
assertKey, booleanValue, booleanValue, booleanValue, booleanValue, booleanValue, doubleValue, doubleValue, floatValue, floatValue, getKey, getValue, integerValue, integerValue, longValue, longValue, setValue, stringValue, stringValue, stringValueDefaultIfBlank, toString, value, value
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

StringPluginProperty

public StringPluginProperty(String key)
                     throws IllegalArgumentException
Constructor. Value is null.

Parameters:
key - key to set.
Throws:
IllegalArgumentException - if key is invalid.
Method Detail

evaluate

public boolean evaluate()

Specified by:
evaluate in interface PluginProperty
Returns:
true if value not null or 'false'.
See Also:
at.aschauer.commons.pentaho.plugin.PluginProperty#evaluate()

appendXml

public void appendXml(StringBuilder builder)

Specified by:
appendXml in interface PluginProperty
Parameters:
builder - builder to append to.
See Also:
at.aschauer.commons.pentaho.plugin.PluginProperty#appendXml(java.lang.StringBuilder)

loadXml

public void loadXml(Node node)

Specified by:
loadXml in interface PluginProperty
Parameters:
node - the node.
See Also:
at.aschauer.commons.pentaho.plugin.PluginProperty#loadXml(org.w3c.dom.Node)

readFromRepositoryStep

public void readFromRepositoryStep(Repository repository,
                                   ObjectId stepId)
                            throws KettleException

Specified by:
readFromRepositoryStep in interface PluginProperty
Parameters:
repository - the repository.
stepId - the stepId.
Throws:
KettleException - ...
See Also:
at.aschauer.commons.pentaho.plugin.PluginProperty#readFromRepositoryStep(org.pentaho.di.repository.Repository, long)

saveToPreferences

public void saveToPreferences(Preferences node)

Specified by:
saveToPreferences in interface PluginProperty
Parameters:
node - preferences node
See Also:
at.aschauer.commons.pentaho.plugin.PluginProperty#saveToPreferences(java.util.prefs.Preferences)

readFromPreferences

public void readFromPreferences(Preferences node)

Specified by:
readFromPreferences in interface PluginProperty
Parameters:
node - preferences node.
See Also:
at.aschauer.commons.pentaho.plugin.PluginProperty#readFromPreferences(java.util.prefs.Preferences)

saveToRepositoryStep

public void saveToRepositoryStep(Repository repository,
                                 ObjectId transformationId,
                                 ObjectId stepId)
                          throws KettleException

Specified by:
saveToRepositoryStep in interface PluginProperty
Parameters:
repository - the repository.
transformationId - the transformationId.
stepId - the stepId.
Throws:
KettleException - ...
See Also:
at.aschauer.commons.pentaho.plugin.PluginProperty#saveToRepositoryStep(org.pentaho.di.repository.Repository, long, long)