Package org.pentaho.reporting.engine.classic.core.function.strings

Class SubStringExpression

java.lang.Object

org.pentaho.reporting.engine.classic.core.function.AbstractExpression

org.pentaho.reporting.engine.classic.core.function.strings.SubStringExpression

All Implemented Interfaces:

Serializable, Cloneable, Expression

public class SubStringExpression
extends AbstractExpression

Deprecated.

Use a formula

Creates a substring of the given text. If the expression has an ellipsis defined, and the given start position and length are greater than the string's length, the ellipsis-text will be appended to indicate that this substring result is only a partial match.

A similiar functionality can be achived using the built-in formula support.

Author:

Thomas Morgner

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
SubStringExpression()	Deprecated. Default Constructor.

Method Summary

Modifier and Type	Method	Description
String	getEllipsis()	Deprecated. Returns the ellipsis-text that indicates partial values.
String	getField()	Deprecated. Returns the name of the datarow-column from where to read the string value.
int	getLength()	Deprecated. Returns the sub-string's length.
int	getStart()	Deprecated. Returns the sub-string's start position.
Object	getValue()	Deprecated. Computes the sub-string.
void	setEllipsis(String ellipsis)	Deprecated. Defines the ellipsis-text that indicates partial values.
void	setField(String field)	Deprecated. Defines the name of the datarow-column from where to read the string value.
void	setLength(int length)	Deprecated. Defines the sub-string's length.
void	setStart(int start)	Deprecated. Defines the sub-string's start position.

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, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SubStringExpression

public SubStringExpression()

Deprecated.

Default Constructor.

Method Detail

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.

getEllipsis

public String getEllipsis()

Deprecated.

Returns the ellipsis-text that indicates partial values.

Returns:

the ellipsis.

setEllipsis

public void setEllipsis(String ellipsis)

Deprecated.

Defines the ellipsis-text that indicates partial values.

Parameters:

ellipsis - the ellipsis.

getStart

public int getStart()

Deprecated.

Returns the sub-string's start position.

Returns:

the start position.

setStart

public void setStart(int start)

Deprecated.

Defines the sub-string's start position. The start position cannot be negative.

Parameters:

start - the start position.

getLength

public int getLength()

Deprecated.

Returns the sub-string's length.

Returns:

the length.

setLength

public void setLength(int length)

Deprecated.

Defines the sub-string's length. The length cannot be negative.

Parameters:

length - the length.

getValue

public Object getValue()

Deprecated.

Computes the sub-string.

Returns:

the value of the function.