EDIT

/**

* Copyright (C) 2007 EDIT

* See LICENSE.TXT at the top of this package for the full license terms.

*/

package eu.etaxonomy.cdm.model.description;

import javax.xml.bind.annotation.XmlAccessorType;

import javax.xml.bind.annotation.XmlElement;

import javax.xml.bind.annotation.XmlElementWrapper;

import javax.xml.bind.annotation.XmlRootElement;

import org.hibernate.annotations.CascadeType;

import eu.etaxonomy.cdm.validation.Level2;

 * {@link SpecimenDescription specimen descriptions} may contain categorical data.<BR>

 * {@link State state terms} such as "blue" or "white". If the color of petals of a

 * 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}

 * Whenever more than one state data belongs to a categorical data they should be

 * This class corresponds partially to CodedDescriptionType according to

 * the SDD schema.

@XmlType(name = "CategoricalData", propOrder = {

    "orderRelevant",

    "unknownData"

@XmlRootElement(name = "CategoricalData")

    //whether the sequence of ordered states is important

    @XmlElement(name = "OrderRelevant")

    private boolean orderRelevant;

    @XmlElementWrapper(name = "States")

    @XmlElement(name = "State")

    @XmlElement(name = "UnknownData")

    private final Boolean unknownData = false;

//****************************** FACTORY METHOD *******************************/

    /**

     * Creates a new empty categorical data instance.

     */

    public static CategoricalData NewInstance(){

        return new CategoricalData();

    }

    /**

     * @param habitat

     * @return

     */

    public static CategoricalData NewInstance(Feature feature) {

        return new CategoricalData( new ArrayList<>() , feature);

    }

     * Creates a new empty categorical data instance.

     */

    public static CategoricalData NewInstance(State state, Feature feature){

        return new CategoricalData( Arrays.asList( new State[]{state}) , feature);

    }

//*******************  CONSTRUCTOR *********************************************/

    /**

     * Class constructor: creates a new empty categorical data instance.

     */

    protected CategoricalData() {

        super(null);

    }

     * Class constructor: creates a new empty categorical data instance.

     */

    protected CategoricalData(List<State> states, Feature feature) {

        super(feature);

        for (State state : states){

    /**

     * Returns the (ordered) list of {@link State states} describing the {@link Feature feature}

     * corresponding to <i>this</i> categorical data.

     */

        return this.stateData;

    /**

     *

     * @param state	the state to be added to <i>this</i> categorical data

        this.stateData.add(stateData);

    /**

     * Convenience method which creates a state data from a given state with no modifiers

     * and adds it to the list of state data

     */

    /**

     *

     * @param  state	the state which should be removed

     * @see     		#addStateData(State)

        this.stateData.remove(stateData);

    //rename to isStateSequenceIntentional ??

    /**

     * 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

     */

    public boolean getOrderRelevant(){

        return this.orderRelevant;

    }

    /**

     * @see	#getOrderRelevant()

     */

    public void setOrderRelevant(boolean orderRelevant){

        this.orderRelevant = orderRelevant;

    }

// ********************* CONVENIENCE ******************************************/

     * Convenience method to test the existence of a given state in the state data.

     * Note: the method ignores modifiers so state data having the state may still be

     * modified by its modifiers.

     *

     * @param state the given {@link State}

     * @return <code>true</code> if the state exists

     */

    public boolean hasState(State state) {

        return getStatesOnly().contains(state);

    }

    @Transient

    public List<State> getStatesOnly(){

                result.add(state);

            }

        return result;

    }

    /**

     * Convenience method which to set the list of states (no modifiers or modifying text allowed).

     * All existing state data are removed.

     * @return

     */

        for (StateData stateData : stateDataList) {

            removeStateData(stateData);

        }

        for (State state : states) {

            addStateData(state);

    @XmlTransient

    @Override

    public boolean isCharacterData() {

        return true;

    }

    @Override

    public String toString() {

                "[" + stateData +

                    (orderRelevant? ", orderRelevant=" + orderRelevant:"") +

                    (unknownData? ", unknownData=" + unknownData:"")

//*********************************** CLONE *****************************************/

     * Clones <i>this</i> categorical data. This is a shortcut that enables to create

     * a new instance that differs only slightly from <i>this</i> categorical data by

     * modifying only some of the attributes.

     * @see eu.etaxonomy.cdm.model.description.DescriptionElementBase#clone()

     * @see java.lang.Object#clone()

     */

    @Override

        //states

        result.stateData = new ArrayList<>();

        for (StateData stateData : getStateData()){

            StateData newState = stateData.clone();

            result.addStateData(newState);

        //no changes to: orderRelevant

        return result;