Package org.pentaho.libformula.editor.function

Class FunctionDescription

java.lang.Object

org.pentaho.libformula.editor.function.FunctionDescription

public class FunctionDescription
extends Object

Author:

matt

    
   Text
   &
   Concatenate two strings.
   Text Left & Text Right
   Text
   None
   Concatenates two text (string) values. Due to the way conversion works, numbers are converted to
   strings. Note that this is equivalent to CONCATENATE(Left,Right).
   (Note: CONCATENATE is not yet available in libformula version 0.1.18.2)
   
   "Hi " & "there" "Hi there"
     1 Simple concatenation.
  "H" & "" "H"
    1 Concatenating an empty string produces no change.
  -5&"b" -5b
    1 Unary - has higher precedence than &
  3&2-1 31
    1 Binary - has higher precedence than &
   
   
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	XML_TAG

Constructor Summary

Constructors

Constructor	Description
FunctionDescription(String category, String name, String description, String syntax, String returns, String constraints, String semantics, List<FunctionExample> functionExamples)
FunctionDescription(Node node)

Method Summary

Modifier and Type	Method	Description
String	getCategory()
String	getConstraints()
String	getDescription()
List<FunctionExample>	getFunctionExamples()
String	getHtmlReport()	Create a text version of a report on this function
String	getName()
String	getReturns()
String	getSemantics()
String	getSyntax()
void	setCategory(String category)
void	setConstraints(String constraints)
void	setDescription(String description)
void	setFunctionExamples(List<FunctionExample> functionExamples)
void	setName(String name)
void	setReturns(String returns)
void	setSemantics(String semantics)
void	setSyntax(String syntax)

Methods inherited from class java.lang.Object

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

Field Details

XML_TAG

public static final String XML_TAG

See Also:

• Constant Field Values

Constructor Details

FunctionDescription

public FunctionDescription(String category,
 String name,
 String description,
 String syntax,
 String returns,
 String constraints,
 String semantics,
 List<FunctionExample> functionExamples)

Parameters:

category -

name -

description -

syntax -

returns -

constraints -

semantics -

functionExamples -

FunctionDescription

public FunctionDescription(Node node)

Method Details

getCategory

public String getCategory()

Returns:

the category

setCategory

public void setCategory(String category)

Parameters:

category - the category to set

getName

public String getName()

Returns:

the name

setName

public void setName(String name)

Parameters:

name - the name to set

getDescription

public String getDescription()

Returns:

the description

setDescription

public void setDescription(String description)

Parameters:

description - the description to set

getSyntax

public String getSyntax()

Returns:

the syntax

setSyntax

public void setSyntax(String syntax)

Parameters:

syntax - the syntax to set

getReturns

public String getReturns()

Returns:

the returns

setReturns

public void setReturns(String returns)

Parameters:

returns - the returns to set

getConstraints

public String getConstraints()

Returns:

the constraints

setConstraints

public void setConstraints(String constraints)

Parameters:

constraints - the constraints to set

getSemantics

public String getSemantics()

Returns:

the semantics

setSemantics

public void setSemantics(String semantics)

Parameters:

semantics - the semantics to set

getFunctionExamples

public List<FunctionExample> getFunctionExamples()

Returns:

the functionExamples

setFunctionExamples

public void setFunctionExamples(List<FunctionExample> functionExamples)

Parameters:

functionExamples - the functionExamples to set

getHtmlReport

public String getHtmlReport()

Create a text version of a report on this function

Returns: