org.openforis.collect.designer.form

Class NodeDefinitionFormObject<T extends NodeDefinition>

java.lang.Object

org.openforis.collect.designer.form.FormObject<T>

org.openforis.collect.designer.form.SurveyObjectFormObject<T>

org.openforis.collect.designer.form.VersionableItemFormObject<T>

org.openforis.collect.designer.form.NodeDefinitionFormObject<T>

Direct Known Subclasses:

AttributeDefinitionFormObject, EntityDefinitionFormObject

public abstract class NodeDefinitionFormObject<T extends NodeDefinition>
extends VersionableItemFormObject<T>

Author:

S. Ricci

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NodeDefinitionFormObject.RelevanceType
static class	NodeDefinitionFormObject.RequirenessType

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	key
protected boolean	measurement
static String	MULTIPLE_FIELD
protected boolean	qualifier
static String	REQUIRED_FIELD
static String	REQUIRENESS_FIELD
protected boolean	showInSummary

Fields inherited from class org.openforis.collect.designer.form.FormObject

VERSION_EMPTY_SELECTION

Method Summary

Modifier and Type	Method and Description
String	getAbbreviatedLabel()
String	getBackgroundColor()
Integer	getBackgroundTransparency()
int	getColumn()
int	getColumnSpan()
String	getDefaultDescription()
String	getDefaultHeadingLabel()
String	getDefaultInstanceLabel()
String	getDescription()
String	getHandheldPromptLabel()
String	getHeadingLabel()
String	getInstanceLabel()
String	getInterviewPromptLabel()
String	getLabelOrientation()
Integer	getLabelWidth()
String	getMaxCountExpression()
String	getMinCountExpression()
String	getName()
String	getNumberLabel()
String	getPaperPromptLabel()
String	getPcPromptLabel()
String	getRelevanceType()
String	getRelevantExpression()
String	getReportingLabel()
String	getRequiredWhenExpression()
String	getRequirenessType()
String	getTabName()
protected UIOptions	getUIOptions(NodeDefinition nodeDefn)
Integer	getWidth()
boolean	isAutoGenerateMinItems()
boolean	isCalculated()
boolean	isCalculatedOnlyOneTime()
boolean	isFromCollectEarthCSV()
boolean	isHideKeyInCollectEarthRecordList()
boolean	isHideWhenNotRelevant()
boolean	isIncludedInCollectEarthHeader()
boolean	isIncludeInDataExport()
boolean	isKey()
boolean	isMeasurement()
boolean	isMultiple()
boolean	isQualifier()
boolean	isShowInSummary()
boolean	isShowInUI()
boolean	isShowReadOnlyFieldInCollectEarth()
void	loadFrom(T source, String language)
static AttributeDefinitionFormObject<?>	newInstance(EntityDefinition parentDefn, AttributeType attributeType)
static NodeDefinitionFormObject<? extends NodeDefinition>	newInstance(EntityDefinition parentDefn, NodeType nodeType, AttributeType attributeType)
protected void	reset()
void	saveTo(T dest, String languageCode)
void	setAbbreviatedLabel(String abbreviatedLabel)
void	setAutoGenerateMinItems(boolean autoGenerateMinItems)
void	setBackgroundColor(String backgroundColor)
void	setBackgroundTransparency(Integer backgroundTransparency)
void	setCalculated(boolean calculated)
void	setCalculatedOnlyOneTime(boolean calculatedOnlyOneTime)
void	setColumn(int column)
void	setColumnSpan(int columnSpan)
void	setDescription(String description)
void	setFromCollectEarthCSV(boolean fromCollectEarthCSV)
void	setHandheldPromptLabel(String handheldPromptLabel)
void	setHeadingLabel(String headingLabel)
void	setHideKeyInCollectEarthRecordList(boolean hideKeyInCollectEarthRecordList)
void	setHideWhenNotRelevant(boolean hideWhenNotRelevant)
void	setIncludedInCollectEarthHeader(boolean showReadOnlyFieldInCollectEarth)
void	setIncludeInDataExport(boolean includeInDataExport)
void	setInstanceLabel(String instanceLabel)
void	setInterviewPromptLabel(String interviewPromptLabel)
void	setKey(boolean key)
void	setLabelOrientation(String labelOrientation)
void	setLabelWidth(Integer labelWidth)
void	setMaxCountExpression(String expression)
void	setMeasurement(boolean measurement)
void	setMinCountExpression(String expression)
void	setMultiple(boolean multiple)
void	setName(String name)
void	setNumberLabel(String numberLabel)
void	setPaperPromptLabel(String paperPromptLabel)
void	setParentDefinition(EntityDefinition parentDefinition)
void	setPcPromptLabel(String pcPromptLabel)
void	setQualifier(boolean qualifier)
void	setRelevanceType(String relevanceType)
void	setRelevantExpression(String relevantExpression)
void	setReportingLabel(String reportingLabel)
void	setRequiredWhenExpression(String requiredWhenExpression)
void	setRequirenessType(String requirenessType)
void	setShowInSummary(boolean showInSummary)
void	setShowInUI(boolean showInUI)
void	setShowReadOnlyFieldInCollectEarth(boolean showReadOnlyFieldInCollectEarth)
void	setTabName(String tabName)
void	setWidth(Integer width)

Methods inherited from class org.openforis.collect.designer.form.VersionableItemFormObject

getDeprecatedVersionId, getSinceVersionId, setDeprecatedVersionId, setSinceVersionId

Methods inherited from class org.openforis.collect.designer.form.FormObject

getSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MULTIPLE_FIELD

public static final String MULTIPLE_FIELD

See Also:

Constant Field Values

REQUIRED_FIELD

public static final String REQUIRED_FIELD

See Also:

Constant Field Values

REQUIRENESS_FIELD

public static final String REQUIRENESS_FIELD

See Also:

Constant Field Values

key

protected boolean key

measurement

protected boolean measurement

qualifier

protected boolean qualifier

showInSummary

protected boolean showInSummary

Method Detail

newInstance

public static NodeDefinitionFormObject<? extends NodeDefinition> newInstance(EntityDefinition parentDefn,
                                                                             NodeType nodeType,
                                                                             AttributeType attributeType)

newInstance

public static AttributeDefinitionFormObject<?> newInstance(EntityDefinition parentDefn,
                                                           AttributeType attributeType)

loadFrom

public void loadFrom(T source,
                     String language)

Overrides:

loadFrom in class VersionableItemFormObject<T extends NodeDefinition>

saveTo

public void saveTo(T dest,
                   String languageCode)

Overrides:

saveTo in class VersionableItemFormObject<T extends NodeDefinition>

reset

protected void reset()

Overrides:

reset in class VersionableItemFormObject<T extends NodeDefinition>

getUIOptions

protected UIOptions getUIOptions(NodeDefinition nodeDefn)

setParentDefinition

public void setParentDefinition(EntityDefinition parentDefinition)

getName

public String getName()

setName

public void setName(String name)

isKey

public boolean isKey()

setKey

public void setKey(boolean key)

isCalculated

public boolean isCalculated()

setCalculated

public void setCalculated(boolean calculated)

isQualifier

public boolean isQualifier()

setQualifier

public void setQualifier(boolean qualifier)

isShowInSummary

public boolean isShowInSummary()

setShowInSummary

public void setShowInSummary(boolean showInSummary)

isIncludeInDataExport

public boolean isIncludeInDataExport()

setIncludeInDataExport

public void setIncludeInDataExport(boolean includeInDataExport)

isShowInUI

public boolean isShowInUI()

setShowInUI

public void setShowInUI(boolean showInUI)

isCalculatedOnlyOneTime

public boolean isCalculatedOnlyOneTime()

setCalculatedOnlyOneTime

public void setCalculatedOnlyOneTime(boolean calculatedOnlyOneTime)

getHeadingLabel

public String getHeadingLabel()

setHeadingLabel

public void setHeadingLabel(String headingLabel)

getInstanceLabel

public String getInstanceLabel()

setInstanceLabel

public void setInstanceLabel(String instanceLabel)

getNumberLabel

public String getNumberLabel()

setNumberLabel

public void setNumberLabel(String numberLabel)

getAbbreviatedLabel

public String getAbbreviatedLabel()

setAbbreviatedLabel

public void setAbbreviatedLabel(String abbreviatedLabel)

getReportingLabel

public String getReportingLabel()

setReportingLabel

public void setReportingLabel(String reportingLabel)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

isMultiple

public boolean isMultiple()

setMultiple

public void setMultiple(boolean multiple)

getInterviewPromptLabel

public String getInterviewPromptLabel()

setInterviewPromptLabel

public void setInterviewPromptLabel(String interviewPromptLabel)

getPaperPromptLabel

public String getPaperPromptLabel()

setPaperPromptLabel

public void setPaperPromptLabel(String paperPromptLabel)

getHandheldPromptLabel

public String getHandheldPromptLabel()

setHandheldPromptLabel

public void setHandheldPromptLabel(String handheldPromptLabel)

getPcPromptLabel

public String getPcPromptLabel()

setPcPromptLabel

public void setPcPromptLabel(String pcPromptLabel)

getRequirenessType

public String getRequirenessType()

setRequirenessType

public void setRequirenessType(String requirenessType)

getRequiredWhenExpression

public String getRequiredWhenExpression()

setRequiredWhenExpression

public void setRequiredWhenExpression(String requiredWhenExpression)

getRelevanceType

public String getRelevanceType()

setRelevanceType

public void setRelevanceType(String relevanceType)

getRelevantExpression

public String getRelevantExpression()

setRelevantExpression

public void setRelevantExpression(String relevantExpression)

isHideWhenNotRelevant

public boolean isHideWhenNotRelevant()

setHideWhenNotRelevant

public void setHideWhenNotRelevant(boolean hideWhenNotRelevant)

getMinCountExpression

public String getMinCountExpression()

setMinCountExpression

public void setMinCountExpression(String expression)

getMaxCountExpression

public String getMaxCountExpression()

setMaxCountExpression

public void setMaxCountExpression(String expression)

isAutoGenerateMinItems

public boolean isAutoGenerateMinItems()

setAutoGenerateMinItems

public void setAutoGenerateMinItems(boolean autoGenerateMinItems)

getTabName

public String getTabName()

setTabName

public void setTabName(String tabName)

getColumn

public int getColumn()

setColumn

public void setColumn(int column)

getColumnSpan

public int getColumnSpan()

setColumnSpan

public void setColumnSpan(int columnSpan)

getWidth

public Integer getWidth()

setWidth

public void setWidth(Integer width)

getLabelWidth

public Integer getLabelWidth()

setLabelWidth

public void setLabelWidth(Integer labelWidth)

getLabelOrientation

public String getLabelOrientation()

setLabelOrientation

public void setLabelOrientation(String labelOrientation)

isFromCollectEarthCSV

public boolean isFromCollectEarthCSV()

setFromCollectEarthCSV

public void setFromCollectEarthCSV(boolean fromCollectEarthCSV)

isIncludedInCollectEarthHeader

public boolean isIncludedInCollectEarthHeader()

setIncludedInCollectEarthHeader

public void setIncludedInCollectEarthHeader(boolean showReadOnlyFieldInCollectEarth)

isShowReadOnlyFieldInCollectEarth

public boolean isShowReadOnlyFieldInCollectEarth()

setShowReadOnlyFieldInCollectEarth

public void setShowReadOnlyFieldInCollectEarth(boolean showReadOnlyFieldInCollectEarth)

isHideKeyInCollectEarthRecordList

public boolean isHideKeyInCollectEarthRecordList()

setHideKeyInCollectEarthRecordList

public void setHideKeyInCollectEarthRecordList(boolean hideKeyInCollectEarthRecordList)

getDefaultInstanceLabel

public String getDefaultInstanceLabel()

getDefaultHeadingLabel

public String getDefaultHeadingLabel()

getDefaultDescription

public String getDefaultDescription()

isMeasurement

public boolean isMeasurement()

setMeasurement

public void setMeasurement(boolean measurement)

getBackgroundTransparency

public Integer getBackgroundTransparency()

setBackgroundTransparency

public void setBackgroundTransparency(Integer backgroundTransparency)

getBackgroundColor

public String getBackgroundColor()

setBackgroundColor

public void setBackgroundColor(String backgroundColor)