* particular tree is described as "mostly blue" and "exceptionally white" two
* {@link StateData state data} instances must be assigned to an instance of the
* present class: the first one with the state "blue" and the {@link Modifier modifier}
- * "mostly" and the second one with the state "white" and the modifier "exceptionally".
+ * "mostly" and the second one with the state "white" and the modifier "exceptionally".
+ * Whenever more than one state data belongs to a categorical data they should be
+ * interpreted as being related by the inclusive disjunction "or".
* <P>
* This class corresponds partially to CodedDescriptionType according to
* the SDD schema.
this.states.remove(state);
}
+ //rename to isStateSequenceIntentional ??
/**
- * Returns the boolean value of the flag indicating whether the {@link StateData state data}
- * belonging to <i>this</i> categorical data should be treated as an
- * {@link List "ordered" list} (true) according to the {@link State states} or as an
- * {@link Set "unordered" set} (false). The use of this flag depends mostly
- * on the {@link Feature feature} of <i>this</i> categorical data.
+ * Returns the boolean value of the flag indicating whether the sequence of
+ * {@link StateData state data} belonging to <i>this</i> categorical data is intentional
+ * (true) and therefore relevant for interpretation or analysis or not (false).
+ * The use of this flag depends mostly on the {@link Feature feature} of <i>this</i> categorical data.
*
* @return the boolean value of the orderRelevant flag
*/
}
-
- /**
- * special kind of OrganismInteraction
- */
/**
* Returns the "hybrid_parent" feature. This feature can only be used
* by {@link TaxonInteraction taxon interactions}.<BR>
}
/**
* Assigns the given feature node as the parent of <i>this</i> feature node.
- * Due to bidirectionality this methods must also add <i>this</i> feature node
+ * Due to bidirectionality this method must also add <i>this</i> feature node
* to the list of children of the given parent.
*
* @param parent the feature node to be set as parent
}
/**
* Assigns the given feature node list as the list of children of
- * <i>this</i> feature node. Due to bidirectionality this methods must also
+ * <i>this</i> feature node. Due to bidirectionality this method must also
* add <i>this</i> feature node to the list of children of the given parent.
*
* @param children the feature node list to be set as child list
}
/**
* Adds the given feature node at the end of the list of children of
- * <i>this</i> feature node. Due to bidirectionality this methods must also
+ * <i>this</i> feature node. Due to bidirectionality this method must also
* assign <i>this</i> feature node as the parent of the given child.
*
* @param child the feature node to be added
/**
* The class to arrange {@link Feature features} (characters) in a tree structure.
- * Feature trees are essential for determination process but may also be used
- * to define flat feature subsets for filtering purposes. Particular feature trees
- * allow different determination processes depending on the concerned taxonomic
- * group.<BR>
+ * Feature trees are essential as interactive multiple-access keys for
+ * determination process and for systematical output arrangement of
+ * {@link DescriptionElementBase description elements} according to different goals but may also be used
+ * to define flat feature subsets for filtering purposes.<BR>
* A feature tree is build on {@link FeatureNode feature nodes}.
* <P>
* This class corresponds partially to ConceptTreeDefType according to the SDD
* schema.
* <P>
- * Note: The tree structure of features needed for a determination process has
+ * Note: The tree structure of features used for purposes described above has
* nothing in common with the possible hierarchical structure of features
* depending on their grade of precision.
*
return result;
}
+ // Delete the isDescriptionSeparated flag ??
/**
* Returns the boolean value of the flag indicating whether the
* {@link DescriptionElementBase description elements} associated with the {@link Feature features}
import javax.persistence.*;
/**
- * The class representing dichotomous or multifurcating authored keys
- * (including legacy data) used to identify (this means to assign {@link Taxon taxa} to)
- * {@link SpecimenOrObservationBase specimens or observations}. The determination process is
- * based on {@link FeatureTree feature trees} and on particular {@link StatisticalMeasurementValue values}
- * or {@link StateData states} for the {@link Feature features} belonging to the feature tree.
+ * The class representing single-access fixed dichotomous or polytomous authored
+ * decision keys (as opposed to {@link FeatureTree multiple-access keys}) used to identify
+ * {@link SpecimenOrObservationBase specimens or observations} (this means to assign {@link Taxon taxa} to).
+ * The determination process is based on the tree structure of the key and on
+ * the statements of its leads.
*
* @author m.doering
* @version 1.0
BGBM BDI Projects / cdmlib.git / commitdiff