/**

 * Alt2XML

 * Copyright © 2014 František Kučera (frantovo.cz)

 *

 * This program is free software: you can redistribute it and/or modify

 * it under the terms of the GNU General Public License as published by

 * the Free Software Foundation, version 3 of the License.

 *

 * This program 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 General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program. If not, see <http://www.gnu.org/licenses/>.

 */

package cz.frantovo.alt2xml;

import cz.frantovo.alt2xml.in.Alt2ContentHandler;

import java.io.IOException;

import java.util.HashMap;

import java.util.Map;

import org.xml.sax.ContentHandler;

import org.xml.sax.DTDHandler;

import org.xml.sax.EntityResolver;

import org.xml.sax.ErrorHandler;

import org.xml.sax.InputSource;

import org.xml.sax.SAXException;

import org.xml.sax.SAXNotRecognizedException;

import org.xml.sax.SAXNotSupportedException;

import org.xml.sax.XMLReader;

/**

 * Recommended base class for all alternative format readers.

 *

 * @author Ing. František Kučera (frantovo.cz)

 */

public abstract class AbstractAlt2XmlReader implements XMLReader {

	private static final String PROPERTY_BASE_URL = "https://alt2xml.globalcode.info/sax-property/";

	protected Alt2ContentHandler contentHandler;

	protected ErrorHandler errorHandler;

	protected DTDHandler dtdHandler;

	protected EntityResolver entityResolver;

	protected Map<String, Object> properties = new HashMap<>();

	protected Map<String, Boolean> features = new HashMap<>();

	@Override

	public void parse(String systemId) throws IOException, SAXException {

		parse(new InputSource(systemId));

	}

	@Override

	public boolean getFeature(String name) throws SAXNotRecognizedException, SAXNotSupportedException {

		/**

		 * TODO:

		 * All XMLReaders are required to recognize

		 * the http://xml.org/sax/features/namespaces

		 * and the http://xml.org/sax/features/namespace-prefixes feature names.

		 */

		Boolean feature = features.get(name);

		return feature == null ? false : feature;

	}

	@Override

	public void setFeature(String name, boolean value) throws SAXNotRecognizedException, SAXNotSupportedException {

		/**

		 * TODO: filtrovat – povolit jen náš jmenný prostor

		 */

		features.put(name, value);

	}

	/**

	 *

	 * @param readerId should be [a-z0-9] and same as specific part of the module/project name (e.g.

	 * alt2xml-in-properties → properties)

	 * @param propertyId should be [a-z0-9-] and unique per module/reader

	 * @return URL

	 */

	protected static String constructPropertyName(String readerId, String propertyId) {

		return PROPERTY_BASE_URL + readerId + "/" + propertyId;

	}

	@Override

	public Object getProperty(String name) throws SAXNotRecognizedException, SAXNotSupportedException {

		return properties.get(name);

	}

	@Override

	public void setProperty(String name, Object value) throws SAXNotRecognizedException, SAXNotSupportedException {

		properties.put(name, value);

	}

	@Override

	public void setEntityResolver(EntityResolver entityResolver) {

		this.entityResolver = entityResolver;

	}

	@Override

	public EntityResolver getEntityResolver() {

		return entityResolver;

	}

	@Override

	public void setDTDHandler(DTDHandler dtdHandler) {

		this.dtdHandler = dtdHandler;

	}

	@Override

	public DTDHandler getDTDHandler() {

		return dtdHandler;

	}

	@Override

	public void setContentHandler(ContentHandler contentHandler) {

		this.contentHandler = new Alt2ContentHandler(contentHandler);

	}

	@Override

	public Alt2ContentHandler getContentHandler() {

		return contentHandler;

	}

	@Override

	public void setErrorHandler(ErrorHandler errorHandler) {

		this.errorHandler = errorHandler;

	}

	@Override

	public ErrorHandler getErrorHandler() {

		return errorHandler;

	}

}