AttributeHandlerInterface.java

/*
*
* Copyright 2005 AgileTec s.r.l. (http://www.agiletec.it) All rights reserved.
*
* This file is part of jAPS software.
* jAPS is a free software; 
* you can redistribute it and/or modify it
* under the terms of the GNU General Public License (GPL) as published by the Free Software Foundation; version 2.
* 
* See the file License for the specific language governing permissions   
* and limitations under the License
* 
* 
* 
* Copyright 2005 AgileTec s.r.l. (http://www.agiletec.it) All rights reserved.
*
*/
package com.agiletec.aps.system.common.entity.parse.attribute;

import java.io.Serializable;

import org.xml.sax.Attributes;
import org.xml.sax.SAXException;

import com.agiletec.aps.system.common.entity.model.attribute.AttributeInterface;

/**
 * Interface for those Handler classes that parse the XML codes of single Attribute Types.
 * @author E.Santoboni
 */
public interface AttributeHandlerInterface extends Serializable {
	
	/**
	 * Return a handler prototype.
	 * @return The handler prototype.
	 */
	public Object getAttributeHandlerPrototype();
	
	/**
	 * Extend the startAttribute of the dell'AttributeHandler, directly handling the XML tags of the
	 * current attribute.
	 * @param attributes The attributes of the current XML tag.
	 * @param qName The name of the current XML tag.
	 * @throws SAXException if errors are detected while parsing
	 */
	public void startAttribute(Attributes attributes, String qName) throws SAXException;
	
	/**
	 * Extend the l'endAttribute of the dell'AttributeHandler, directly handling the XML tags of the
	 * current attribute
	 * @param qName The name of the current XML tag.
	 * @param textBuffer The text read inside the XML tag.
	 */
	public void endAttribute(String qName, StringBuffer textBuffer);
	
	/**
	 * Test if the name of the XML tag corresponds to the ending Entity Attribute.
	 * @param qName The name of the current XML tag.
	 * @return true If the tag corresponds to the end of the current Entity Attribute, false otherwise.
	 */
	public boolean isEndAttribute(String qName);
	
	/**
	 * Set up the current attribute.
	 * @param currentAttr The attribute.
	 */
	public void setCurrentAttr(AttributeInterface currentAttr);
	
}