package org.matheclipse.core.interfaces;


/**
 * Interface for pattern objects. A pettern object cannot be shared between
 * multiple rules
 * 
 */
public interface IPattern extends IPatternObject, IExpr {
	/**
	 * Get the index in which this pattern is stored during pattern-matching for a
	 * given rule.
	 * 
	 * @param index
	 */
//	public int getIndex();

	/**
	 * Set the index in which this pattern is stored during pattern-matching for a
	 * given rule.
	 * 
	 * @param index
	 * @see PatternMatcher#determinePatternParameters()
	 */
//	public void setIndex(int index);

	/**
	 * Get the additional patterns condition expression
	 * 
	 * @return may return null;
	 */
	public IExpr getCondition();

	/**
	 * Return true, if the expression fullfills the patterns
	 * additional condition
	 * 
	 * @param expr
	 * @return
	 */
	public boolean isConditionMatched(IExpr expr);

	/**
	 * Return true, if the expression is a blank pattern
	 * 
	 * @return
	 */
	public boolean isBlank();

	/**
	 * Return true, if the expression is a pattern with an associated
	 * default value,
	 * 
	 * @return
	 */
	public boolean isDefault();
}