Package com.stimulsoft.report.dictionary.functions

Class StiFunction

java.lang.Object

com.stimulsoft.report.dictionary.functions.StiFunction

All Implemented Interfaces:

IStiAppFunction, Comparable<StiFunction>

public class StiFunction
extends Object
implements Comparable<StiFunction>, IStiAppFunction

Copyright Stimulsoft

Constructor Summary

Constructors

Constructor	Description
StiFunction(String category, String groupFunctionName, String functionName, String description, String typeOfFunction, StiSystemType returnType, String returnDescription, StiSystemType[] argumentTypes, String[] argumentNames, String[] argumentDescriptions)

Method Summary

Modifier and Type	Method	Description
int	compareTo(StiFunction o)
String	convertTypeToString(StiSystemType type, StiReportLanguageType language)
String[]	getArgumentDescriptions()
String[]	getArgumentNames()
StiSystemType[]	getArgumentTypes()
String	getCategory()
String	getDescription()
String	getFunctionName()
String	getFunctionString(StiReportLanguageType language)
String	getFunctionString(StiReportLanguageType language, boolean addFunctionName)
String	getGroupFunctionName()
String	GetLongFunctionString(StiReportLanguageType language)
String	getName()	Returns a name of the function.
String	getReturnDescription()
StiSystemType	getReturnType()
String	getTypeOfFunction()
Object	invoke(List<Object> arguments)	Invokes this function with specified arguments.
boolean	isUseFullPath()
void	setArgumentDescriptions(String[] argumentDescriptions)
void	setArgumentNames(String[] argumentNames)
void	setArgumentTypes(StiSystemType[] argumentTypes)
void	setCategory(String category)
void	setDescription(String description)
void	setFunctionName(String functionName)
void	setGroupFunctionName(String groupFunctionName)
void	setReturnDescription(String returnDescription)
void	setReturnType(StiSystemType returnType)
void	setTypeOfFunction(String typeOfFunction)
void	setUseFullPath(boolean useFullPath)

Methods inherited from class java.lang.Object

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

Constructor Details

StiFunction

public StiFunction(String category,
 String groupFunctionName,
 String functionName,
 String description,
 String typeOfFunction,
 StiSystemType returnType,
 String returnDescription,
 StiSystemType[] argumentTypes,
 String[] argumentNames,
 String[] argumentDescriptions)

Method Details

getFunctionString

public String getFunctionString(StiReportLanguageType language)

getFunctionString

public String getFunctionString(StiReportLanguageType language,
 boolean addFunctionName)

GetLongFunctionString

public String GetLongFunctionString(StiReportLanguageType language)

convertTypeToString

public String convertTypeToString(StiSystemType type,
 StiReportLanguageType language)

isUseFullPath

public boolean isUseFullPath()

Returns:

the useFullPath

setUseFullPath

public void setUseFullPath(boolean useFullPath)

Parameters:

useFullPath - the useFullPath to set

getCategory

public String getCategory()

Returns:

the category

setCategory

public void setCategory(String category)

Parameters:

category - the category to set

getGroupFunctionName

public String getGroupFunctionName()

Returns:

the groupFunctionName

setGroupFunctionName

public void setGroupFunctionName(String groupFunctionName)

Parameters:

groupFunctionName - the groupFunctionName to set

getFunctionName

public String getFunctionName()

Returns:

the functionName

setFunctionName

public void setFunctionName(String functionName)

Parameters:

functionName - the functionName to set

getDescription

public String getDescription()

Returns:

the description

setDescription

public void setDescription(String description)

Parameters:

description - the description to set

getTypeOfFunction

public String getTypeOfFunction()

Returns:

the typeOfFunction

setTypeOfFunction

public void setTypeOfFunction(String typeOfFunction)

Parameters:

typeOfFunction - the typeOfFunction to set

getReturnType

public StiSystemType getReturnType()

Returns:

the returnType

setReturnType

public void setReturnType(StiSystemType returnType)

Parameters:

returnType - the returnType to set

getReturnDescription

public String getReturnDescription()

Returns:

the returnDescription

setReturnDescription

public void setReturnDescription(String returnDescription)

Parameters:

returnDescription - the returnDescription to set

getArgumentTypes

public StiSystemType[] getArgumentTypes()

Returns:

the argumentTypes

setArgumentTypes

public void setArgumentTypes(StiSystemType[] argumentTypes)

Parameters:

argumentTypes - the argumentTypes to set

getArgumentNames

public String[] getArgumentNames()

Returns:

the argumentNames

setArgumentNames

public void setArgumentNames(String[] argumentNames)

Parameters:

argumentNames - the argumentNames to set

getArgumentDescriptions

public String[] getArgumentDescriptions()

Returns:

the argumentDescriptions

setArgumentDescriptions

public void setArgumentDescriptions(String[] argumentDescriptions)

Parameters:

argumentDescriptions - the argumentDescriptions to set

compareTo

public int compareTo(StiFunction o)

Specified by:

compareTo in interface Comparable<StiFunction>

getName

public String getName()

Description copied from interface: IStiAppFunction

Returns a name of the function.

Specified by:

getName in interface IStiAppFunction

Returns:

The name of the function.

invoke

public Object invoke(List<Object> arguments)

Description copied from interface: IStiAppFunction

Invokes this function with specified arguments.

Specified by:

invoke in interface IStiAppFunction

Parameters:

arguments - The list of arguments.

Returns:

The result of the function calling.