com.stimulsoft.report.dictionary.functions

Class StiFunction

java.lang.Object

com.stimulsoft.report.dictionary.functions.StiFunction

All Implemented Interfaces:

java.lang.Comparable<StiFunction>

public class StiFunction
extends java.lang.Object
implements java.lang.Comparable<StiFunction>

Copyright Stimulsoft

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(StiFunction o)
java.lang.String	convertTypeToString(StiSystemType type, StiReportLanguageType language)
java.lang.String[]	getArgumentDescriptions()
java.lang.String[]	getArgumentNames()
StiSystemType[]	getArgumentTypes()
java.lang.String	getCategory()
java.lang.String	getDescription()
java.lang.String	getFunctionName()
java.lang.String	getFunctionString(StiReportLanguageType language)
java.lang.String	getFunctionString(StiReportLanguageType language, boolean addFunctionName)
java.lang.String	getGroupFunctionName()
java.lang.String	GetLongFunctionString(StiReportLanguageType language)
java.lang.String	getReturnDescription()
StiSystemType	getReturnType()
java.lang.String	getTypeOfFunction()
boolean	isUseFullPath()
void	setArgumentDescriptions(java.lang.String[] argumentDescriptions)
void	setArgumentNames(java.lang.String[] argumentNames)
void	setArgumentTypes(StiSystemType[] argumentTypes)
void	setCategory(java.lang.String category)
void	setDescription(java.lang.String description)
void	setFunctionName(java.lang.String functionName)
void	setGroupFunctionName(java.lang.String groupFunctionName)
void	setReturnDescription(java.lang.String returnDescription)
void	setReturnType(StiSystemType returnType)
void	setTypeOfFunction(java.lang.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 Detail

StiFunction

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

Method Detail

getFunctionString

public java.lang.String getFunctionString(StiReportLanguageType language)

getFunctionString

public java.lang.String getFunctionString(StiReportLanguageType language,
                                 boolean addFunctionName)

GetLongFunctionString

public java.lang.String GetLongFunctionString(StiReportLanguageType language)

convertTypeToString

public java.lang.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 java.lang.String getCategory()

Returns:

the category

setCategory

public void setCategory(java.lang.String category)

Parameters:

category - the category to set

getGroupFunctionName

public java.lang.String getGroupFunctionName()

Returns:

the groupFunctionName

setGroupFunctionName

public void setGroupFunctionName(java.lang.String groupFunctionName)

Parameters:

groupFunctionName - the groupFunctionName to set

getFunctionName

public java.lang.String getFunctionName()

Returns:

the functionName

setFunctionName

public void setFunctionName(java.lang.String functionName)

Parameters:

functionName - the functionName to set

getDescription

public java.lang.String getDescription()

Returns:

the description

setDescription

public void setDescription(java.lang.String description)

Parameters:

description - the description to set

getTypeOfFunction

public java.lang.String getTypeOfFunction()

Returns:

the typeOfFunction

setTypeOfFunction

public void setTypeOfFunction(java.lang.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 java.lang.String getReturnDescription()

Returns:

the returnDescription

setReturnDescription

public void setReturnDescription(java.lang.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 java.lang.String[] getArgumentNames()

Returns:

the argumentNames

setArgumentNames

public void setArgumentNames(java.lang.String[] argumentNames)

Parameters:

argumentNames - the argumentNames to set

getArgumentDescriptions

public java.lang.String[] getArgumentDescriptions()

Returns:

the argumentDescriptions

setArgumentDescriptions

public void setArgumentDescriptions(java.lang.String[] argumentDescriptions)

Parameters:

argumentDescriptions - the argumentDescriptions to set

compareTo

public int compareTo(StiFunction o)

Specified by:

compareTo in interface java.lang.Comparable<StiFunction>