org.pentaho.reporting.engine.classic.core.function.strings
Class CapitalizeStringExpression

java.lang.Object
  extended by org.pentaho.reporting.engine.classic.core.function.AbstractExpression
      extended by org.pentaho.reporting.engine.classic.core.function.strings.CapitalizeStringExpression
All Implemented Interfaces:
Serializable, Cloneable, Expression

Deprecated. Use a formula instead.

public class CapitalizeStringExpression
extends AbstractExpression

A expression that transforms all first letters of a given string into upper-case letters.

Author:
Thomas Morgner
See Also:
Serialized Form

Constructor Summary
CapitalizeStringExpression()
          Deprecated. Default constructor.
 
Method Summary
 String getField()
          Deprecated. Returns the name of the datarow-column from where to read the string value.
 Object getValue()
          Deprecated. Capitalizes the string that has been read from the defined field.
 boolean isFirstWordOnly()
          Deprecated. Returns, whether only the first word should be capitalized.
 void setField(String field)
          Deprecated. Defines the name of the datarow-column from where to read the string value.
 void setFirstWordOnly(boolean firstWordOnly)
          Deprecated. Defines, whether only the first word should be capitalized.
 
Methods inherited from class org.pentaho.reporting.engine.classic.core.function.AbstractExpression
clone, getDataRow, getDependencyLevel, getInstance, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isDeepTraversing, isPreserve, setActive, setDependencyLevel, setName, setPreserve, setRuntime
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CapitalizeStringExpression

public CapitalizeStringExpression()
Deprecated. 
Default constructor.

Method Detail

isFirstWordOnly

public boolean isFirstWordOnly()
Deprecated. 
Returns, whether only the first word should be capitalized.

Returns:
true, if the first word should be capitalized, false if all words should be capitalized.

setFirstWordOnly

public void setFirstWordOnly(boolean firstWordOnly)
Deprecated. 
Defines, whether only the first word should be capitalized.

Parameters:
firstWordOnly - true, if the first word should be capitalized, false if all words should be capitalized.

getField

public String getField()
Deprecated. 
Returns the name of the datarow-column from where to read the string value.

Returns:
the field.

setField

public void setField(String field)
Deprecated. 
Defines the name of the datarow-column from where to read the string value.

Parameters:
field - the field.

getValue

public Object getValue()
Deprecated. 
Capitalizes the string that has been read from the defined field.

Returns:
the value of the function.