Condition.java

/*
 * Copyright (C) 2009 JavaRosa
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

package org.openrosa.client.jr.core.model.condition;

import java.io.IOException;
import java.util.Vector;

import org.openrosa.client.java.io.DataInputStream;
import org.openrosa.client.java.io.DataOutputStream;
import org.openrosa.client.jr.core.model.FormDef;
import org.openrosa.client.jr.core.model.instance.FormInstance;
import org.openrosa.client.jr.core.model.instance.TreeElement;
import org.openrosa.client.jr.core.model.instance.TreeReference;
import org.openrosa.client.jr.core.util.externalizable.DeserializationException;
import org.openrosa.client.jr.core.util.externalizable.ExtUtil;
import org.openrosa.client.jr.core.util.externalizable.PrototypeFactory;

public class Condition extends Triggerable {
	public static final int ACTION_NULL = 0;
	public static final int ACTION_SHOW = 1;
	public static final int ACTION_HIDE = 2;
	public static final int ACTION_ENABLE = 3;
	public static final int ACTION_DISABLE = 4;
	public static final int ACTION_LOCK = 5;
	public static final int ACTION_UNLOCK = 6;
	public static final int ACTION_REQUIRE = 7;
	public static final int ACTION_DONT_REQUIRE = 8;
	
	public int trueAction;
	public int falseAction;
		
	public Condition () {

	}
	
	public Condition (IConditionExpr expr, int trueAction, int falseAction, TreeReference contextRef) {
		this(expr, trueAction, falseAction, contextRef, new Vector());
	}
	
	public Condition (IConditionExpr expr, int trueAction, int falseAction, TreeReference contextRef, Vector targets) {
		super(expr, contextRef);
		this.trueAction = trueAction;
		this.falseAction = falseAction;
		this.targets = targets;
	}
	
	public Object eval (FormInstance model, EvaluationContext evalContext) {
		return new Boolean(expr.eval(model, evalContext));
	}
	
	public boolean evalBool (FormInstance model, EvaluationContext evalContext) {
		return ((Boolean)eval(model, evalContext)).booleanValue();
	}
	
	public void apply (TreeReference ref, Object rawResult, FormInstance model, FormDef f) {
		boolean result = ((Boolean)rawResult).booleanValue();
		performAction(model.resolveReference(ref), result ? trueAction : falseAction);
	}

	public boolean canCascade () {
		return (trueAction == ACTION_SHOW || trueAction == ACTION_HIDE);
	}
	
	private void performAction (TreeElement node, int action) {
		switch (action) {
		case ACTION_NULL: break;
		case ACTION_SHOW:         node.setRelevant(true); break;
		case ACTION_HIDE:         node.setRelevant(false); break;
		case ACTION_ENABLE:       node.setEnabled(true); break;
		case ACTION_DISABLE:      node.setEnabled(false); break;
		case ACTION_LOCK:         /* not supported */; break;
		case ACTION_UNLOCK:       /* not supported */; break;
		case ACTION_REQUIRE:      node.setRequired(true); break;
		case ACTION_DONT_REQUIRE: node.setRequired(false); break;
		}
	}
		
	//conditions are equal if they have the same actions, expression, and triggers, but NOT targets or context ref
	public boolean equals (Object o) {
		if (o instanceof Condition) {
			Condition c = (Condition)o;
			if (this == c)
				return true;
			
			return (this.trueAction == c.trueAction && this.falseAction == c.falseAction && super.equals(c));
		} else {
			return false;
		}			
	}
	
	public void readExternal(DataInputStream in, PrototypeFactory pf) throws IOException, DeserializationException {
		super.readExternal(in, pf);
		trueAction = ExtUtil.readInt(in);
		falseAction = ExtUtil.readInt(in);
	}
	
	public void writeExternal(DataOutputStream out) throws IOException {
		super.writeExternal(out);
		ExtUtil.writeNumeric(out, trueAction);
		ExtUtil.writeNumeric(out, falseAction);
	}
}