src.it.unimi.dsi.parser.ParsingFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dsiutils Show documentation

The DSI utilities are a mishmash of classes accumulated during the last twenty years in projects developed at the DSI (Dipartimento di Scienze dell'Informazione, i.e., Information Sciences Department), now DI (Dipartimento di Informatica, i.e., Informatics Department), of the Universita` degli Studi di Milano.

There is a newer version: 2.7.3

Show newest version

package it.unimi.dsi.parser;

/*
 * DSI utilities
 *
 * Copyright (C) 2005-2018 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 3 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, see .
 *
 */

import it.unimi.dsi.lang.MutableString;

/** A set of coherent methods to turn element-type, attribute and entity names to unique interned instances.
 *
 * The {@link it.unimi.dsi.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.parser.Element}, {@link it.unimi.dsi.parser.Attribute}
 * or {@link it.unimi.dsi.parser.Entity}, respectively. The returned element must
 * be an interned, unique representation.
 *
 * 
For instance, the {@linkplain it.unimi.dsi.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).
 *
 * 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
 */

public interface ParsingFactory {

	/** Returns the {@link it.unimi.dsi.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.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.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);
}