org.molgenis.model.elements

Class Parameter

java.lang.Object

org.molgenis.model.elements.Parameter

All Implemented Interfaces:

Serializable

public class Parameter
extends Object
implements Serializable

Describes a field in an entity.

Version:

1.0.0

Author:

RA Scheltema

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Parameter.Type Description of the different types of a field.

Field Summary

Fields

Modifier and Type	Field and Description
static int	LENGTH_NOT_SET Fixed value used for determining the not-set value for the varchar.

Constructor Summary

Constructors

Constructor and Description
Parameter(Method parent, Parameter.Type type) Constructor specifically meant for constructing a return-type.
Parameter(Method parent, Parameter.Type type, String name, String label, boolean nillable, String default_value) Standard constructor, which sets all the common variables for a field.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
String	getDefaultValue() Returns the value the database should set for the field when there is no value set.
String	getDescription() Returns the description of the entity.
Method	getEntity()
List<String>	getEnumOptions()
String	getLabel() This method returns the label of this field.
String	getName() This method returns the name of this field.
Method	getParent() Deprecated.
Parameter.Type	getType() This method returns the type of this field.
Object	getUserData()
int	getVarCharLength() When this field is of type Type.VARCHAR, this method returns the maximum length the varchar can be.
int	hashCode() Returns a hash code value for the Field.
boolean	isNillable() Returns whether this field can be NULL in the database.
void	setDescription(String description) Sets the description of this entity.
void	setEnumOptions(List<String> options)
void	setType(Parameter.Type type)
void	setUserData(Object obj)
void	setVarCharLength(int length) When this field is of type Type.VARCHAR, this method sets the maximum length the varchar can be.
String	toString() Returns a string representation of the Field.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

LENGTH_NOT_SET

public static final int LENGTH_NOT_SET

Fixed value used for determining the not-set value for the varchar.

See Also:

Constant Field Values

Constructor Detail

Parameter

public Parameter(Method parent,
                 Parameter.Type type)

Constructor specifically meant for constructing a return-type. This avoids the need for an additional class describing basically the same thing. The properties: name, label and default_value are set to null and nillable to false.

See Also:

Parameter(Method, Type, String, String, boolean, String)

Parameter

public Parameter(Method parent,
                 Parameter.Type type,
                 String name,
                 String label,
                 boolean nillable,
                 String default_value)

Standard constructor, which sets all the common variables for a field. Extra fields can be set with the appropriate access methods.

Parameters:

type - The type of the field.

name - The name of the field, which needs to be unique for the entity.

label - The label of the field, which is used for the user interface.

nillable - Indicates whether this field can have the value NULL in the database.

Method Detail

getParent

@Deprecated
public Method getParent()

Deprecated.

getEntity

public Method getEntity()

getType

public Parameter.Type getType()

This method returns the type of this field.

Returns:

The type of this field.

setType

public void setType(Parameter.Type type)

Parameters:

type -

getName

public String getName()

This method returns the name of this field.

Returns:

The name of this field.

getLabel

public String getLabel()

This method returns the label of this field.

Returns:

The label of this field.

isNillable

public boolean isNillable()

Returns whether this field can be NULL in the database.

Returns:

True when this field can be NULL, false otherwise.

getDefaultValue

public String getDefaultValue()

Returns the value the database should set for the field when there is no value set.

Returns:

The default-value.

getDescription

public String getDescription()

Returns the description of the entity.

Returns:

The description.

setDescription

public void setDescription(String description)

Sets the description of this entity.

setEnumOptions

public void setEnumOptions(List<String> options)
                    throws MolgenisModelException

Throws:

MolgenisModelException

getEnumOptions

public List<String> getEnumOptions()
                            throws MolgenisModelException

Throws:

MolgenisModelException

setVarCharLength

public void setVarCharLength(int length)
                      throws Exception

When this field is of type Type.VARCHAR, this method sets the maximum length the varchar can be. When this field is not of type Type.VARCHAR, this method raises an exception.

Parameters:

length - The maximum length the varchar field can be.

Throws:

Exception - When the field is not of type Type.VARCHAR.

getVarCharLength

public int getVarCharLength()
                     throws Exception

When this field is of type Type.VARCHAR, this method returns the maximum length the varchar can be. When this field is not of type Type.VARCHAR, this method raises an exception.

Returns:

The maximum length the varchar field can be.

Throws:

Exception - When the field is not of type Type.VARCHAR.

setUserData

public void setUserData(Object obj)

getUserData

public Object getUserData()

toString

public String toString()

Returns a string representation of the Field.

Overrides:

toString in class Object

Returns:

The string-representation.

equals

public boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

Overrides:

equals in class Object

Parameters:

obj - The reference object with which to compare.

Returns:

True if this object is the same as the obj argument, false otherwise.

hashCode

public int hashCode()

Returns a hash code value for the Field. This hash-code is used for quick searching in a vector of fields.

Overrides:

hashCode in class Object

Returns:

The hash-value for this field.