All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.xerces.util.ParserConfigurationSettings Maven / Gradle / Ivy

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.xerces.util;

import java.util.ArrayList;
import java.util.HashMap;

import org.apache.xerces.impl.Constants;
import org.apache.xerces.xni.parser.XMLComponentManager;
import org.apache.xerces.xni.parser.XMLConfigurationException;

/**
 * This class implements the basic operations for managing parser
 * configuration features and properties. This utility class can
 * be used as a base class for parser configurations or separately
 * to encapsulate a number of parser settings as a component
 * manager.
 * 

* This class can be constructed with a "parent" settings object * (in the form of an XMLComponentManager) that allows * parser configuration settings to be "chained" together. * * @author Andy Clark, IBM * * @version $Id: ParserConfigurationSettings.java 447241 2006-09-18 05:12:57Z mrglavas $ */ public class ParserConfigurationSettings implements XMLComponentManager { protected static final String PARSER_SETTINGS = Constants.XERCES_FEATURE_PREFIX + Constants.PARSER_SETTINGS; // // Data // // data /** Recognized properties. */ protected ArrayList fRecognizedProperties; /** Properties. */ protected HashMap fProperties; /** Recognized features. */ protected ArrayList fRecognizedFeatures; /** Features. */ protected HashMap fFeatures; /** Parent parser configuration settings. */ protected XMLComponentManager fParentSettings; // // Constructors // /** Default Constructor. */ public ParserConfigurationSettings() { this(null); } // () /** * Constructs a parser configuration settings object with a * parent settings object. */ public ParserConfigurationSettings(XMLComponentManager parent) { // create storage for recognized features and properties fRecognizedFeatures = new ArrayList(); fRecognizedProperties = new ArrayList(); // create table for features and properties fFeatures = new HashMap(); fProperties = new HashMap(); // save parent fParentSettings = parent; } // (XMLComponentManager) // // XMLParserConfiguration methods // /** * Allows a parser to add parser specific features to be recognized * and managed by the parser configuration. * * @param featureIds An array of the additional feature identifiers * to be recognized. */ public void addRecognizedFeatures(String[] featureIds) { // add recognized features int featureIdsCount = featureIds != null ? featureIds.length : 0; for (int i = 0; i < featureIdsCount; i++) { String featureId = featureIds[i]; if (!fRecognizedFeatures.contains(featureId)) { fRecognizedFeatures.add(featureId); } } } // addRecognizedFeatures(String[]) /** * Set the state of a feature. * * Set the state of any feature in a SAX2 parser. The parser * might not recognize the feature, and if it does recognize * it, it might not be able to fulfill the request. * * @param featureId The unique identifier (URI) of the feature. * @param state The requested state of the feature (true or false). * * @exception org.apache.xerces.xni.parser.XMLConfigurationException If the * requested feature is not known. */ public void setFeature(String featureId, boolean state) throws XMLConfigurationException { // check and store checkFeature(featureId); fFeatures.put(featureId, state ? Boolean.TRUE : Boolean.FALSE); } // setFeature(String,boolean) /** * Allows a parser to add parser specific properties to be recognized * and managed by the parser configuration. * * @param propertyIds An array of the additional property identifiers * to be recognized. */ public void addRecognizedProperties(String[] propertyIds) { // add recognizedProperties int propertyIdsCount = propertyIds != null ? propertyIds.length : 0; for (int i = 0; i < propertyIdsCount; i++) { String propertyId = propertyIds[i]; if (!fRecognizedProperties.contains(propertyId)) { fRecognizedProperties.add(propertyId); } } } // addRecognizedProperties(String[]) /** * setProperty * * @param propertyId * @param value * @exception org.apache.xerces.xni.parser.XMLConfigurationException If the * requested feature is not known. */ public void setProperty(String propertyId, Object value) throws XMLConfigurationException { // check and store checkProperty(propertyId); fProperties.put(propertyId, value); } // setProperty(String,Object) // // XMLComponentManager methods // /** * Returns the state of a feature. * * @param featureId The feature identifier. * @return true if the feature is supported * * @throws XMLConfigurationException Thrown for configuration error. * In general, components should * only throw this exception if * it is really * a critical error. */ public boolean getFeature(String featureId) throws XMLConfigurationException { Boolean state = (Boolean) fFeatures.get(featureId); if (state == null) { checkFeature(featureId); return false; } return state.booleanValue(); } // getFeature(String):boolean /** * Returns the value of a property. * * @param propertyId The property identifier. * @return the value of the property * * @throws XMLConfigurationException Thrown for configuration error. * In general, components should * only throw this exception if * it is really * a critical error. */ public Object getProperty(String propertyId) throws XMLConfigurationException { Object propertyValue = fProperties.get(propertyId); if (propertyValue == null) { checkProperty(propertyId); } return propertyValue; } // getProperty(String):Object // // Protected methods // /** * Check a feature. If feature is known and supported, this method simply * returns. Otherwise, the appropriate exception is thrown. * * @param featureId The unique identifier (URI) of the feature. * * @exception org.apache.xerces.xni.parser.XMLConfigurationException If the * requested feature is not known. */ protected void checkFeature(String featureId) throws XMLConfigurationException { // check feature if (!fRecognizedFeatures.contains(featureId)) { if (fParentSettings != null) { fParentSettings.getFeature(featureId); } else { short type = XMLConfigurationException.NOT_RECOGNIZED; throw new XMLConfigurationException(type, featureId); } } } // checkFeature(String) /** * Check a property. If the property is known and supported, this method * simply returns. Otherwise, the appropriate exception is thrown. * * @param propertyId The unique identifier (URI) of the property * being set. * @exception org.apache.xerces.xni.parser.XMLConfigurationException If the * requested feature is not known. */ protected void checkProperty(String propertyId) throws XMLConfigurationException { // check property if (!fRecognizedProperties.contains(propertyId)) { if (fParentSettings != null) { fParentSettings.getProperty(propertyId); } else { short type = XMLConfigurationException.NOT_RECOGNIZED; throw new XMLConfigurationException(type, propertyId); } } } // checkProperty(String) } // class ParserConfigurationSettings





© 2015 - 2024 Weber Informatics LLC | Privacy Policy