Field (molgenis-core 1.2.0 API)

java.lang.Object
- org.molgenis.model.elements.Field

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

FieldWithXrefLabel
```
public class Field
extends Object
implements Serializable
```
Describes a field in an entity.

Version:

1.0.0

Author:

RA Scheltema, MA Swertz

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String TYPE_FIELD

Fields
Modifier and Type	Field and Description
`static String`	`TYPE_FIELD`

Constructor Summary

Constructors
Constructor and Description
`Field(Entity parent, FieldType type, String name, String label, boolean auto, boolean nillable, boolean readonly, String default_value)` Standard constructor, which sets all the common variables for a field.
`Field(Entity parent, FieldType type, String name, String label, boolean auto, boolean nillable, boolean readonly, String default_value, String jpaCascade)` Standard constructor, which sets all the common variables for a field.
`Field(Entity parent, String name, FieldType type)`
`Field(Field field)` copy-constructor
`Field(String name)`

Method Summary

Methods
Modifier and Type	Method and Description
`Map<String,List<Field>>`	`allPossibleXrefLabels()`
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`String`	`getAnnotations()`
`String`	`getDefaultCode()`
`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.
`Entity`	`getEntity()`
`Vector<String>`	`getEnumOptions()`
`String`	`getFilterfield()`
`String`	`getFiltertype()`
`String`	`getFiltervalue()`
`String`	`getFormatString()`
`String`	`getJpaCascade()`
`String`	`getLabel()` This method returns the label of this field.
`Integer`	`getLength()`
`Long`	`getMaxRange()`
`Long`	`getMinRange()`
`String`	`getMrefLocalid()`
`String`	`getMrefName()` Gets the name of the link-table when this field is a XREF_MULTIPLE.
`String`	`getMrefRemoteid()`
`String`	`getName()` This method returns the name of this field.
`Entity`	`getParent()` Deprecated.
`String`	`getSqlName()`
`String`	`getTableName()`
`FieldType`	`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.
`Entity`	`getXrefEntity()` Returns the name of the entity this field is referencing to.
`String`	`getXrefEntityName()`
`Field`	`getXrefField()` Returns the name of the field of the entity this field is referencing to.
`String`	`getXrefFieldName()`
`List<String>`	`getXrefLabelNames()` Returns the label of this reference.
`List<Field>`	`getXrefLabelPath(String label)`
`List<Field>`	`getXrefLabels()`
`List<String>`	`getXrefLabelsTemp()`
`SimpleTree<SimpleTree<?>>`	`getXrefLabelTree()` Return a tree wich describes the path to xref labels.
`SimpleTree<SimpleTree<?>>`	`getXrefLabelTree(boolean useJavaNames)`
`protected void`	`getXrefLabelTree(List<String> labels, SimpleTree<?> parent)` Creates a tree with leafs that match labels and nodes that match entities.
`protected void`	`getXrefLabelTree(List<String> labels, SimpleTree<?> parent, boolean useJavaNames)` Creates a tree with leafs that match labels and nodes that match entities.
`boolean`	`hasFilter()`
`int`	`hashCode()` Returns a hash code value for the Field.
`boolean`	`isAggregateable()`
`boolean`	`isAuto()` Returns whether this field is auto-assigned by the database.
`boolean`	`isCyclic()`
`boolean`	`isHidden()`
`boolean`	`isLocal()` Returns whether this field is locally available in the table, or whether it is located in another table (for example link-table).
`boolean`	`isMRef()` Returns whether this field is a mref.
`boolean`	`isNillable()` Returns whether this field can be NULL in the database.
`boolean`	`isReadOnly()` Returns whether this field is read-only in the database.
`boolean`	`isSystem()` Returns whether this field is a system-field.
`boolean`	`isUnique()` If this a unique field? If this field is part of a compound key it will return false
`boolean`	`isXRef()` Returns whether this field is a xref.
`boolean`	`isXrefCascade()`
`void`	`setAggregateable(boolean aggregateable)`
`void`	`setAnnotations(String annotations)`
`void`	`setAuto(boolean auto)`
`void`	`setDefaultCode(String default_code)`
`void`	`setDescription(String description)` Sets the description of this entity.
`void`	`setDevaultValue(String value)`
`void`	`setEntity(Entity entity)`
`void`	`setEnumOptions(Vector<String> options)`
`void`	`setFilter(boolean filter)`
`void`	`setFilterfield(String filterfield)`
`void`	`setFiltertype(String filtertype)`
`void`	`setFiltervalue(String filtervalue)`
`void`	`setHidden(boolean hidden)`
`void`	`setJpaCascade(String jpaCascade)`
`void`	`setLabel(String label)`
`void`	`setMaxRange(Long maxRange)`
`void`	`setMinRange(Long minRange)`
`void`	`setMrefLocalid(String mref_localid)`
`void`	`setMrefName(String linktable)` Sets the name of the link-table when this field is a XREF_MULTIPLE.
`void`	`setMrefRemoteid(String mref_remoteid)`
`void`	`setName(String name)`
`void`	`setNillable(boolean nillable)`
`void`	`setReadonly(boolean readonly)`
`void`	`setSystem(boolean s)` With this set-function the system-property can be set.
`void`	`setTableName(String tableName)`
`void`	`setType(FieldType 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.
`void`	`setXrefCascade(boolean xrefCascade)`
`void`	`setXRefEntity(String xref_entity)`
`void`	`setXrefField(String xrefField)`
`void`	`setXrefLabelNames(List<String> labelNames)`
`void`	`setXRefVariables(String entity, String field, List<String> labels)` With this method all the additional information for this xref-field can be set.
`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
  - TYPE_FIELD
```
public static final String TYPE_FIELD
```
    See Also:
    Constant Field Values
- Constructor Detail
  - Field
```
public Field(Entity parent,
     String name,
     FieldType type)
```
  - Field
```
public Field(Entity parent,
     FieldType type,
     String name,
     String label,
     boolean auto,
     boolean nillable,
     boolean readonly,
     String default_value,
     String jpaCascade)
```
    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.
    auto - Indicates whether this field needs to assigned a value by the database.
    nillable - Indicates whether this field can have the value NULL in the database.
    readonly - Indicates whether this field is readonly.
    jpaCascade - Makes it possible to use JPA Cascade options to streamline object datbase interaction, see JPA documentation for details
  - Field
```
public Field(String name)
```
  - Field
```
public Field(Entity parent,
     FieldType type,
     String name,
     String label,
     boolean auto,
     boolean nillable,
     boolean readonly,
     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.
    auto - Indicates whether this field needs to assigned a value by the database.
    nillable - Indicates whether this field can have the value NULL in the database.
    readonly - Indicates whether this field is readonly.
  - Field
```
public Field(Field field)
```
    copy-constructor
- Method Detail
  - getParent
```
@Deprecated
public Entity getParent()
```
    Deprecated.
  - getEntity
```
public Entity getEntity()
```
  - getType
```
public FieldType getType()
```
    This method returns the type of this field.
    
    Returns:
    The type of this field.
  - setType
```
public void setType(FieldType type)
```
    Parameters:
    type -
  - getFormatString
```
public String getFormatString()
```
  - getName
```
public String getName()
```
    This method returns the name of this field.
    
    Returns:
    The name of this field.
  - setName
```
public void setName(String name)
```
  - getLabel
```
public String getLabel()
```
    This method returns the label of this field.
    
    Returns:
    The label of this field.
  - setLabel
```
public void setLabel(String label)
```
  - setAuto
```
public void setAuto(boolean auto)
```
  - isAuto
```
public boolean isAuto()
```
    Returns whether this field is auto-assigned by the database.
    
    Returns:
    True when this field is auto-assigned, false otherwise.
  - isNillable
```
public boolean isNillable()
```
    Returns whether this field can be NULL in the database.
    
    Returns:
    True when this field can be NULL, false otherwise.
  - isAggregateable
```
public boolean isAggregateable()
```
  - setAggregateable
```
public void setAggregateable(boolean aggregateable)
```
  - setReadonly
```
public void setReadonly(boolean readonly)
```
  - isHidden
```
public boolean isHidden()
```
  - setHidden
```
public void setHidden(boolean hidden)
```
  - isReadOnly
```
public boolean isReadOnly()
```
    Returns whether this field is read-only in the database.
    
    Returns:
    True when this field is read-only, false otherwise.
  - isSystem
```
public boolean isSystem()
```
    Returns whether this field is a system-field. When it is a system-field, it will not be displayed in the user-interface.
    
    Returns:
    True when this field is a system-field, false otherwise.
  - setSystem
```
public void setSystem(boolean s)
```
    With this set-function the system-property can be set.
    
    Parameters:
    s - The system boolean.
  - isLocal
```
public boolean isLocal()
```
    Returns whether this field is locally available in the table, or whether it is located in another table (for example link-table).
    
    Returns:
    Whether this field is located in the table
  - isCyclic
```
public boolean isCyclic()
                 throws MolgenisModelException
```
    Throws:
    
    MolgenisModelException
  - isXRef
```
public boolean isXRef()
```
    Returns whether this field is a xref.
    
    Returns:
    Whether this field is a xref.
  - isMRef
```
public boolean isMRef()
```
    Returns whether this field is a mref.
    
    Returns:
    Whether this field is a mref.
  - getDefaultValue
```
public String getDefaultValue()
```
    Returns the value the database should set for the field when there is no value set.
    
    Returns:
    The default-value.
  - setDevaultValue
```
public void setDevaultValue(String 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(Vector<String> options)
```
  - getEnumOptions
```
public Vector<String> getEnumOptions()
                              throws MolgenisModelException
```
    Throws:
    
    MolgenisModelException
  - setVarCharLength
```
public void setVarCharLength(int length)
```
    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 MolgenisModelException
```
    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.
    
    MolgenisModelException
  - setXRefEntity
```
public void setXRefEntity(String xref_entity)
```
  - setXRefVariables
```
public void setXRefVariables(String entity,
                    String field,
                    List<String> labels)
```
    With this method all the additional information for this xref-field can be set. When this field is not of type Type.XREF_SINGLE or Type.XREF_MULTIPLE an exception is raised.
    
    Parameters:
    entity - The entity this field references.
    field - The field of the entity this field references.
    label - The label of this xref.
    
    Throws:
    
    Exception - When this field is not of type Type.XREF_SINGLE or Type.XREF_MULTIPLE
  - getXrefEntity
```
public Entity getXrefEntity()
                     throws MolgenisModelException
```
    Returns the name of the entity this field is referencing to. When this field is not of type Type.XREF_SINGLE or Type.XREF_MULTIPLE an exception is raised.
    
    Returns:
    The name of the entity this field is referencing.
    
    Throws:
    
    Exception - When this field is not of type Type.XREF_SINGLE or Type.XREF_MULTIPLE
    
    MolgenisModelException
  - getXrefEntityName
```
public String getXrefEntityName()
                         throws MolgenisModelException
```
    Throws:
    
    MolgenisModelException
  - getXrefField
```
public Field getXrefField()
                   throws MolgenisModelException
```
    Returns the name of the field of the entity this field is referencing to. When this field is not of type Type.XREF_SINGLE or Type.XREF_MULTIPLE an exception is raised.
    
    Returns:
    The name of the field of the entity this field is referencing.
    
    Throws:
    
    Exception
    
    Exception - When this field is not of type Type.XREF_SINGLE or Type.XREF_MULTIPLE
    
    MolgenisModelException
  - getXrefFieldName
```
public String getXrefFieldName()
```
  - getXrefLabelNames
```
public List<String> getXrefLabelNames()
                               throws MolgenisModelException
```
    Returns the label of this reference. When this field is not of type Type.XREF_SINGLE or Type.XREF_MULTIPLE an exception is raised.
    
    Returns:
    The label of this reference.
    
    Throws:
    
    MolgenisModelException
    
    Exception - When this field is not of type Type.XREF_SINGLE or Type.XREF_MULTIPLE
  - getXrefLabelTree
```
public SimpleTree<SimpleTree<?>> getXrefLabelTree()
                                           throws MolgenisModelException
```
    Return a tree wich describes the path to xref labels. This allows also to use indirect secondary keys as labels. For example: Sample is identified by {name,Investigation.name}. Investigation.name has a path via sample.investigation.
    
    Returns:
    
    Throws:
    
    MolgenisModelException
  - getXrefLabelTree
```
public SimpleTree<SimpleTree<?>> getXrefLabelTree(boolean useJavaNames)
                                           throws MolgenisModelException
```
    Throws:
    
    MolgenisModelException
  - getXrefLabelTree
```
protected void getXrefLabelTree(List<String> labels,
                    SimpleTree<?> parent)
                         throws MolgenisModelException
```
    Creates a tree with leafs that match labels and nodes that match entities. xref fields will result in sub trees.
    
    Parameters:
    labels - to be matched
    path - so far in the tree to allow for recursion
    
    Throws:
    
    MolgenisModelException
  - getXrefLabelTree
```
protected void getXrefLabelTree(List<String> labels,
                    SimpleTree<?> parent,
                    boolean useJavaNames)
                         throws MolgenisModelException
```
    Creates a tree with leafs that match labels and nodes that match entities. xref fields will result in sub trees.
    
    Parameters:
    labels - to be matched
    path - so far in the tree to allow for recursion
    
    Throws:
    
    MolgenisModelException
  - getXrefLabelPath
```
public List<Field> getXrefLabelPath(String label)
                             throws MolgenisModelException
```
    Throws:
    
    MolgenisModelException
  - getXrefLabels
```
public List<Field> getXrefLabels()
                          throws MolgenisModelException
```
    Throws:
    
    MolgenisModelException
  - getXrefLabelsTemp
```
public List<String> getXrefLabelsTemp()
                               throws MolgenisModelException
```
    Throws:
    
    MolgenisModelException
  - getMrefName
```
public String getMrefName()
```
    Gets the name of the link-table when this field is a XREF_MULTIPLE. When this field is not of type Type.XREF_MULTIPLE an exception is raised.
    
    Returns:
    The name of the linktable.
    
    Throws:
    
    Exception - When this field is not of type Type.XREF_MULTIPLE
  - setMrefName
```
public void setMrefName(String linktable)
```
    Sets the name of the link-table when this field is a XREF_MULTIPLE. When this field is not of type Type.XREF_MULTIPLE an exception is raised.
    
    Parameters:
    linktable - The name of the linktable.
    
    Throws:
    
    Exception - When this field is not of type Type.XREF_MULTIPLE
  - getMrefLocalid
```
public String getMrefLocalid()
```
  - setMrefLocalid
```
public void setMrefLocalid(String mref_localid)
```
  - getMrefRemoteid
```
public String getMrefRemoteid()
```
  - setMrefRemoteid
```
public void setMrefRemoteid(String mref_remoteid)
```
  - setUserData
```
public void setUserData(Object obj)
```
  - getUserData
```
public Object getUserData()
```
  - getDefaultCode
```
public String getDefaultCode()
```
  - setDefaultCode
```
public void setDefaultCode(String default_code)
```
  - 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.
  - getAnnotations
```
public String getAnnotations()
```
  - setAnnotations
```
public void setAnnotations(String annotations)
```
  - hasFilter
```
public boolean hasFilter()
```
  - setFilter
```
public void setFilter(boolean filter)
```
  - getFilterfield
```
public String getFilterfield()
```
  - setFilterfield
```
public void setFilterfield(String filterfield)
```
  - getFiltertype
```
public String getFiltertype()
```
  - setFiltertype
```
public void setFiltertype(String filtertype)
```
  - getFiltervalue
```
public String getFiltervalue()
```
  - setNillable
```
public void setNillable(boolean nillable)
```
  - setFiltervalue
```
public void setFiltervalue(String filtervalue)
```
  - setEntity
```
public void setEntity(Entity entity)
```
  - setXrefField
```
public void setXrefField(String xrefField)
```
  - setXrefLabelNames
```
public void setXrefLabelNames(List<String> labelNames)
```
  - getMinRange
```
public Long getMinRange()
```
  - setMinRange
```
public void setMinRange(Long minRange)
```
  - getMaxRange
```
public Long getMaxRange()
```
  - setMaxRange
```
public void setMaxRange(Long maxRange)
```
  - allPossibleXrefLabels
```
public Map<String,List<Field>> allPossibleXrefLabels()
                                              throws MolgenisModelException
```
    Throws:
    
    MolgenisModelException
  - getLength
```
public Integer getLength()
                  throws MolgenisModelException
```
    Throws:
    
    MolgenisModelException
  - isXrefCascade
```
public boolean isXrefCascade()
```
  - setXrefCascade
```
public void setXrefCascade(boolean xrefCascade)
```
  - getJpaCascade
```
public String getJpaCascade()
```
  - setJpaCascade
```
public void setJpaCascade(String jpaCascade)
```
  - setTableName
```
public void setTableName(String tableName)
```
  - getTableName
```
public String getTableName()
```
  - getSqlName
```
public String getSqlName()
```
  - isUnique
```
public boolean isUnique()
                 throws MolgenisModelException
```
    If this a unique field? If this field is part of a compound key it will return false
    
    Returns:
    
    Throws:
    
    MolgenisModelException

Class Field

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TYPE_FIELD

Constructor Detail

Field

Field

Field

Field

Field

Method Detail

getParent

getEntity

getType

setType

getFormatString

getName

setName

getLabel

setLabel

setAuto

isAuto

isNillable

isAggregateable

setAggregateable

setReadonly

isHidden

setHidden

isReadOnly

isSystem

setSystem

isLocal

isCyclic

isXRef

isMRef

getDefaultValue

setDevaultValue

getDescription

setDescription

setEnumOptions

getEnumOptions

setVarCharLength

getVarCharLength

setXRefEntity

setXRefVariables

getXrefEntity

getXrefEntityName

getXrefField

getXrefFieldName

getXrefLabelNames

getXrefLabelTree

getXrefLabelTree

getXrefLabelTree

getXrefLabelTree

getXrefLabelPath

getXrefLabels

getXrefLabelsTemp

getMrefName

setMrefName

getMrefLocalid

setMrefLocalid

getMrefRemoteid

setMrefRemoteid

setUserData

getUserData

getDefaultCode

setDefaultCode

toString

equals

hashCode

getAnnotations

setAnnotations

hasFilter

setFilter

getFilterfield

setFilterfield

getFiltertype