DefVar.java

package ecologylab.bigsemantics.metametadata;

import java.util.List;

import javax.xml.namespace.QName;
import javax.xml.xpath.XPathConstants;

import ecologylab.bigsemantics.Utils;
import ecologylab.bigsemantics.actions.SemanticsConstants;
import ecologylab.serialization.ElementState;
import ecologylab.serialization.annotations.simpl_collection;
import ecologylab.serialization.annotations.simpl_nowrap;
import ecologylab.serialization.annotations.simpl_scalar;
import ecologylab.serialization.formatenums.StringFormat;
import ecologylab.serialization.types.ScalarType;

public class DefVar extends ElementState
{
	/**
	 * Name of the variable to be declared
	 */
	@simpl_scalar
	private String			name;

	/**
	 * XPath to evaluate this variable
	 */
	@simpl_collection("xpath")
	@simpl_nowrap
	private List<String> xpaths;

	/**
	 * The return type of this evaluation after applicatiopn of XPath
	 */
	@simpl_scalar
	private String			type;

	/**
	 * Node on which this XPath has to be applied
	 */
	@simpl_scalar
	private String			contextNode;

	/**
	 * scalar type of variable
	 */
	@simpl_scalar
	private ScalarType	scalarType;

	/**
	 * Value of variable
	 */
	@simpl_scalar
	private String			value;

	/**
	 * comment for this variable
	 */
	@simpl_scalar
	private String			comment;

	/**
	 * @return the name
	 */
	public final String getName()
	{
		return name;
	}

	/**
	 * @param name
	 *          the name to set
	 */
	public final void setName(String name)
	{
		this.name = name;
	}

	/**
	 * @return the xpath
	 */
	public final List<String> getXpaths()
	{
		return xpaths;
	}

	/**
	 * @return the type
	 */
	public final QName getType()
	{
		if (SemanticsConstants.NODE_SET.equals(type))
		{
			return XPathConstants.NODESET;
		}
		else if (SemanticsConstants.NODE.equals(type))
		{
			return XPathConstants.NODE;
		}
		return null;
	}

	/**
	 * @param type
	 *          the type to set
	 */
	public final void setType(String type)
	{
		this.type = type;
	}

	/**
	 * @return the comment
	 */
	public final String getComment()
	{
		return comment;
	}

	/**
	 * @param comment
	 *          the comment to set
	 */
	public final void setComment(String comment)
	{
		this.comment = comment;
	}

	/**
	 * @return the node
	 */
	public final String getContextNode()
	{
		return contextNode;
	}

	/**
	 * @param node
	 *          the node to set
	 */
	public final void setContextNode(String node)
	{
		this.contextNode = node;
	}

	/**
	 * @return the scalarType
	 */
	public ScalarType getScalarType()
	{
		return scalarType;
	}

	/**
	 * @param scalarType
	 *          the scalarType to set
	 */
	public void setScalarType(ScalarType scalarType)
	{
		this.scalarType = scalarType;
	}

	/**
	 * @return the value
	 */
	public String getValue()
	{
		return value;
	}
	
	@Override
	public String toString()
	{
	  return Utils.serializeToString(this, StringFormat.XML).toString();
	}

}