parsingfactory.java

MG4J (Managing Gigabytes for Java) is a free full-text search engine for large document collections

package it.unimi.dsi.mg4j.util.parser;

import it.unimi.dsi.mg4j.util.MutableString;

/*		 
 * MG4J: Managing Gigabytes for Java
 *
 * Copyright (C) 2005-2007 Sebastiano Vigna 
 *
 *  This library is free software; you can redistribute it and/or modify it
 *  under the terms of the GNU Lesser General Public License as published by the Free
 *  Software Foundation; either version 2.1 of the License, or (at your option)
 *  any later version.
 *
 *  This library is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 *  or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
 *  for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 */

/** A set of coherent methods to turn element-type, attribute and entity names to unique interned instances.
 * 
 * <p>The {@link it.unimi.dsi.mg4j.util.parser.BulletParser} needs a way to turn
 * a name (for an element type, attribute, or entity) into a corresponding object
 * of type {@link it.unimi.dsi.mg4j.util.parser.Element}, {@link it.unimi.dsi.mg4j.util.parser.Attribute}
 * or {@link it.unimi.dsi.mg4j.util.parser.Entity}, respectively. The returned element must
 * be an interned, unique representation. 
 * 
 * <P>For instance, the {@linkplain it.unimi.dsi.mg4j.util.parser.HTMLFactory standard factory for
 * HTML} parsing has ready-made interned versions of all names in the (X)HTML specification,
 * and returns them upon request, but other policies are possible. For instance, instances of 
 * {@link WellFormedXmlFactory} intern every seen name, without reference to a data type (except
 * for entities, in which case the HTML set is used).
 * 
 * <P>The idea of factoring out the creation of interned counterparts of
 * SGML/XML syntactical objects is due to Fabien Campagne.
 * 
 * @author Sebastiano Vigna
 * @since 1.0.2
 * @deprecated Moved to <code>dsiutils</code>.
 */

@Deprecated
public interface ParsingFactory {

	/** Returns the {@link it.unimi.dsi.mg4j.util.parser.Element} associated
	 * to a name.
	 * @param name the name of an element type.
	 * @return the corresponding interned {@link Element} object.
	 */
	public Element getElement( final MutableString name );

	/** Returns the {@link it.unimi.dsi.mg4j.util.parser.Attribute} associated
	 * to a name.
	 * @param name the name of an attribute.
	 * @return the corresponding interned {@link Attribute} object.
	 */
	public Attribute getAttribute( final MutableString name );

	/** Returns the {@link it.unimi.dsi.mg4j.util.parser.Entity} associated
	 * to a name.
	 * @param name the name of an entity.
	 * @return the corresponding interned {@link Entity} object.
	 */
	public Entity getEntity( final MutableString name );
}