|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.metamatrix.query.function.metadata.FunctionParameter
public class FunctionParameter
A function parameter defines the name and description of an input or output
parameter for a function. The name should not be null, but that is not
verified by this class. Validation of this object can be done with the
FunctionMetadataValidator
. The type string used in the function
parameter should be one of the standard type names defined in
DataTypeManager.DefaultDataTypes
.
Field Summary | |
---|---|
static java.lang.String |
OUTPUT_PARAMETER_NAME
|
Constructor Summary | |
---|---|
FunctionParameter()
Construct a function parameter with no attributes. |
|
FunctionParameter(java.lang.String name,
java.lang.String type)
Construct a function parameter with no description. |
|
FunctionParameter(java.lang.String name,
java.lang.String type,
java.lang.String description)
Construct a function parameter with all attributes. |
|
FunctionParameter(java.lang.String name,
java.lang.String type,
java.lang.String description,
boolean vararg)
|
Method Summary | |
---|---|
boolean |
equals(java.lang.Object obj)
Compare with other object for equality. |
java.lang.String |
getDescription()
Get description of parameter |
java.lang.String |
getName()
Return name of parameter. |
java.lang.String |
getType()
Get type of parameter |
int |
hashCode()
Return hash code for this parameter. |
boolean |
isVarArg()
|
void |
setDescription(java.lang.String description)
Set description of parameter |
void |
setName(java.lang.String name)
Set name |
void |
setType(java.lang.String type)
Set type of parameter |
void |
setVarArg(boolean isVarArg)
|
java.lang.String |
toString()
Return string version for debugging purposes |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String OUTPUT_PARAMETER_NAME
Constructor Detail |
---|
public FunctionParameter()
public FunctionParameter(java.lang.String name, java.lang.String type)
name
- Nametype
- Type from standard set of typespublic FunctionParameter(java.lang.String name, java.lang.String type, java.lang.String description)
name
- Nametype
- Type from standard set of typesdescription
- Descriptionpublic FunctionParameter(java.lang.String name, java.lang.String type, java.lang.String description, boolean vararg)
Method Detail |
---|
public java.lang.String getName()
public void setName(java.lang.String name)
name
- Namepublic java.lang.String getDescription()
public void setDescription(java.lang.String description)
description
- Descriptionpublic java.lang.String getType()
DataTypeManager.DefaultDataTypes
public void setType(java.lang.String type)
type
- Type of parameterDataTypeManager.DefaultDataTypes
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public void setVarArg(boolean isVarArg)
public boolean isVarArg()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |