|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectphenote.datamodel.CharField
public class CharField
| Field Summary | |
|---|---|
(package private) static java.lang.String |
LIST_DELIM
|
| Constructor Summary | |
|---|---|
CharField(CharFieldEnum c)
used for relationship |
|
CharField(FieldConfig fc)
heck why not just pass in the FieldConfig with its xml config bean |
|
CharField(java.lang.String name,
java.lang.String tag,
phenote.config.xml.FieldDocument.Field.Type.Enum type)
a generic field with no char field enum - get hip type is from field xml bean: TERM, FREE_TEXT... |
|
| Method Summary | |
|---|---|
void |
addOntology(Ontology o)
|
CharFieldEnum |
getCharFieldEnum()
|
java.lang.String |
getComponentsGroup()
|
boolean |
getCopyEnabled()
|
phenote.config.xml.FieldDocument.Field |
getFieldXmlConfigBean()
returns xml bean from configuration used to make field, null if doesnt have one |
Ontology |
getFirstOntology()
|
java.lang.String |
getName()
|
Ontology |
getOntology()
|
Ontology |
getOntologyForName(java.lang.String ontologyName)
Returns Ontology with name ontologyName (ignores case), ont ex if dont have it |
java.util.List<Ontology> |
getOntologyList()
|
CharField |
getPickListSourceField()
|
Ontology |
getPostCompRelOntol()
|
java.lang.String |
getTag()
Tag is what comes from datatag in config, used for referencing field (like from smart atlas servlet), and as dangling prefix for obo mapping, if datatag not set in config, returns name |
(package private) boolean |
hasCharFieldEnum()
generic fields dont have enums |
boolean |
hasMoreThanOneOntology()
|
boolean |
hasOneOntology()
|
boolean |
hasOntologies()
|
boolean |
hasOntology(java.lang.String ontologyName)
|
boolean |
isAutoAnnotId()
|
boolean |
isAutoGenerated()
whether field is auto generated when creating new annotations, for instance date_created is automatically set with every new annotation eventually will have user & date_last_update as well... |
boolean |
isComparison()
|
boolean |
isCompound()
If a CharField is compound, there is another group of fields in the config which the value of this field can be parsed into - this is used by the CharacterListFieldGui. |
boolean |
isDate()
|
boolean |
isField(java.lang.String tag)
returns true if field has has tag or name of input tag |
boolean |
isFreeText()
|
boolean |
isID()
|
boolean |
isInt()
|
boolean |
isList()
return true if holds a list of CharFieldValues, false if just 1 char field value |
boolean |
isPickList()
|
boolean |
isReadOnly()
|
boolean |
isTerm()
This should be redundant with hasOntologies (though with instances this may change?) when ontology is added type is automatically set to TERM |
CharFieldValue |
makeValue(CharacterI c,
java.lang.String valueString)
if free text returns string charfieldValue, for ontology field valueString is id and searches ontologies for id, throws CharFieldException if invalid date for date field (used to for term not found but now creates dangler instead) this deals with postcomp too) if term is dangler then dangler gets id (valueString) but no name use makeValue(Char,String,String) to get dangler name set as well also deals with lists in format: "xxx","yyy",... |
CharFieldValue |
makeValue(CharacterI c,
java.lang.String valueString,
java.lang.String danglerName)
makes value - value string for term is id - if term is dangler (not in ontology) and danglerName is non null, then danglers name is set to danglerName, danglerName is ONLY used for danglers |
boolean |
postCompAllowed()
whether this field allows for post composition - from config - allowed? how bout has? |
void |
setCopyEnabled(boolean cp)
|
(package private) void |
setIsAutoGenerated(boolean isGen)
set isAutoGenerated state - should this come from enum? |
void |
setName(java.lang.String n)
|
void |
setPostCompAllowed(boolean pca)
|
void |
setPostCompRelOntol(Ontology o)
|
void |
setType(phenote.config.xml.FieldDocument.Field.Type.Enum t)
part of constructor? probably |
java.lang.String |
toString()
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
static final java.lang.String LIST_DELIM
| Constructor Detail |
|---|
public CharField(CharFieldEnum c)
public CharField(java.lang.String name,
java.lang.String tag,
phenote.config.xml.FieldDocument.Field.Type.Enum type)
public CharField(FieldConfig fc)
| Method Detail |
|---|
public phenote.config.xml.FieldDocument.Field getFieldXmlConfigBean()
public void setCopyEnabled(boolean cp)
public boolean getCopyEnabled()
public void setType(phenote.config.xml.FieldDocument.Field.Type.Enum t)
public void addOntology(Ontology o)
public void setName(java.lang.String n)
public java.lang.String getName()
public java.lang.String getTag()
public boolean isField(java.lang.String tag)
public CharFieldEnum getCharFieldEnum()
boolean hasCharFieldEnum()
public java.util.List<Ontology> getOntologyList()
public boolean isFreeText()
public boolean isInt()
public boolean isPickList()
public CharField getPickListSourceField()
public boolean isCompound()
public java.lang.String getComponentsGroup()
public boolean isTerm()
public boolean isDate()
public boolean isID()
public boolean isComparison()
public boolean isReadOnly()
public boolean isAutoAnnotId()
public boolean isList()
public boolean hasOntologies()
public boolean hasOneOntology()
public boolean hasMoreThanOneOntology()
public Ontology getOntology()
public Ontology getFirstOntology()
public boolean hasOntology(java.lang.String ontologyName)
public Ontology getOntologyForName(java.lang.String ontologyName)
public void setPostCompAllowed(boolean pca)
public boolean postCompAllowed()
public void setPostCompRelOntol(Ontology o)
public Ontology getPostCompRelOntol()
public CharFieldValue makeValue(CharacterI c,
java.lang.String valueString)
throws CharFieldException
CharFieldException
public CharFieldValue makeValue(CharacterI c,
java.lang.String valueString,
java.lang.String danglerName)
throws CharFieldException
CharFieldExceptionpublic boolean isAutoGenerated()
void setIsAutoGenerated(boolean isGen)
public java.lang.String toString()
toString in class java.lang.Object
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||