jadex.xml.reader.IXMLReader Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jadex-xml Show documentation

Jadex XML is an XML data binding framework for Java and also for other representations. The main idea of Jadex XML is that neither the XML-Schema on the one side nor the Java classes on the other side should define other binding. Instead, a separate mapping between both is used as a mediation. This allows designing the XML representation independent of the Java side but still being able to connect both as desired. This idea was first put forward by the JiBX data binding framework. Jadex XML pushes it further by combining it with the configuration by exception principle. The framework can detect obvious correspondences between both sides automatically and only needs configuration information when translations are necessary. The configuration information is currently specified directly in form of Java configuration classes.

There is a newer version: 3.0.117

Show newest version

package jadex.xml.reader;

import java.util.LinkedList;
import java.util.Map;

import jadex.xml.stax.ILocation;
import jadex.xml.stax.QName;
import jadex.xml.stax.XmlTag;

public interface IXMLReader
{
	/**
	 *  Gets the XML event type.
	 *  
	 *  @return Event type.
	 */
	public int getEventType();
	
	/**
	 *  Returns if the reader has more events.
	 *  
	 *  @return True, if there are more events.
	 */
	public boolean hasNext();
	
	/**
	 *  Selects the next event.
	 */
	public int next();
	
	/**
	 *  Get the XML tag struct.
	 *  
	 *  @return Struct defining the tag.
	 */
	public XmlTag getXmlTag();
	
	/**
	 *  Get the XML tag struct of the last closed tag.
	 *  
	 *  @return Struct defining the tag.
	 */
	public XmlTag getClosedTag();
	
	/**
	 *  Get the XML tag stack.
	 *  
	 *  @return Stack defining the tags.
	 */
	public LinkedList getXmlTagStack();
	
	/**
	 *  Returns the attributes.
	 *  
	 *  @return The attributes.
	 */
	public Map getAttributes();
	
	/**
	 *  Get the text for the element.
	 *  
	 *  @return The text.
	 */
	public String getText();
	
	/**
	 *  Closes the reader.
	 */
	public void close();

	/**
	 * Returns the current parser location.
	 * @return Location
	 */
	public ILocation getLocation();

	String getLocalName();

	int getAttributeCount();

	String getAttributeLocalName(int i);

	String getAttributeValue(int i);

	QName getName();

	String getAttributePrefix(int i);

	String getAttributeNamespace(int i);

}