_br-ode-1.X.svn/bpel-api/src/main/java/org/apache/ode/bpel/common/OptionalCorrelationKey.java

package org.apache.ode.bpel.common;

import java.io.Serializable;
import java.util.ArrayList;

import org.apache.ode.utils.CollectionUtils;

/**
 * An instance of this class represents a correlation key that has a 'join' use case in the process definition.
 * For instance, if a correlation set, 'orderId' is used as initiate="no" in 3 occurrences and initiate="join"
 * in 1 occurrence, any correlation keys that are derived from the correlation set, 'orderId' is an 
 * optional correlation key.
 * 
 * @author sean
 *
 */
public class OptionalCorrelationKey extends CorrelationKey implements Serializable {
    private static final long serialVersionUID = 1L;

    public OptionalCorrelationKey(String csetName, String[] keyValues) {
    	super(csetName, keyValues);
    }

    public OptionalCorrelationKey(String canonicalForm) {
    	super(canonicalForm);
    }

    /**
     * @see Object#toString
     */
    public String toString() {
        StringBuffer buf = new StringBuffer("{OptionalCorrelationKey ");
        buf.append("setName=");
        buf.append(getCorrelationSetName());
        buf.append(", values=");
        buf.append(CollectionUtils.makeCollection(ArrayList.class, getValues()));
        buf.append('}');

        return buf.toString();
    }
}