https://xerces.apache.org/xerces2-j/: Xerces2 is the next generation of high performance, fully compliant XML parsers in the Apache Xerces family. This new version of Xerces introduces the Xerces Native Interface (XNI), a complete framework for building parser components and configurations that is extremely modular and easy to program. The Apache Xerces2 parser is the reference implementation of XNI but other parser components, configurations, and parsers can be written using the Xerces Native Interface. For complete design and implementation documents, refer to the XNI Manual. Xerces2 is a fully conforming XML Schema 1.0 processor. A partial experimental implementation of the XML Schema 1.1 Structures and Datatypes Working Drafts (December 2009) and an experimental implementation of the XML Schema Definition Language (XSD): Component Designators (SCD) Candidate Recommendation (January 2010) are provided for evaluation. For more information, refer to the XML Schema page. Xerces2 also provides a complete implementation of the Document Object Model Level 3 Core and Load/Save W3C Recommendations and provides a complete implementation of the XML Inclusions (XInclude) W3C Recommendation. It also provides support for OASIS XML Catalogs v1.1. Xerces2 is able to parse documents written according to the XML 1.1 Recommendation, except that it does not yet provide an option to enable normalization checking as described in section 2.13 of this specification. It also handles namespaces according to the XML Namespaces 1.1 Recommendation, and will correctly serialize XML 1.1 documents if the DOM level 3 load/save APIs are in use. 
/*
 * 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.impl.xs.identity;

import org.apache.xerces.xs.ShortList;



Interface for storing values associated to an identity constraint. 
Each value stored corresponds to a field declared for the identity
constraint. One instance of an object implementing this interface
is created for each identity constraint per element declaration in
the instance document to store the information for this identity
constraint.


Note: The component performing identity constraint
collection and validation is responsible for providing an 
implementation of this interface. The component is also responsible
for performing the necessary checks required by each type of identity
constraint.

Author:Andy Clark, IBM
@xerces.internal
Version:$Id: ValueStore.java 520039 2007-03-19 18:34:38Z mrglavas $
/**
 * Interface for storing values associated to an identity constraint. 
 * Each value stored corresponds to a field declared for the identity
 * constraint. One instance of an object implementing this interface
 * is created for each identity constraint per element declaration in
 * the instance document to store the information for this identity
 * constraint.
 * <p>
 * <strong>Note:</strong> The component performing identity constraint
 * collection and validation is responsible for providing an 
 * implementation of this interface. The component is also responsible
 * for performing the necessary checks required by each type of identity
 * constraint.
 *
 * @xerces.internal 
 *
 * @author Andy Clark, IBM
 *
 * @version $Id: ValueStore.java 520039 2007-03-19 18:34:38Z mrglavas $
 */
public interface ValueStore {
    
    //
    // ValueStore methods
    //

    
Adds the specified value to the value store.

Params:
  • field – The field associated to the value. This reference
             is used to ensure that each field only adds a value
             once within a selection scope.
  • mayMatch – a flag indiciating whether the field may be matched.
  • actualValue – The value to add.
  • valueType – Type of the value to add.
  • itemValueType – If the value is a list, a list of types for each of the values in the list.
/** 
     * Adds the specified value to the value store.
     *
     * @param field The field associated to the value. This reference
     *              is used to ensure that each field only adds a value
     *              once within a selection scope.
     * @param mayMatch a flag indiciating whether the field may be matched.
     * @param actualValue The value to add.
     * @param valueType Type of the value to add.
     * @param itemValueType If the value is a list, a list of types for each of the values in the list.
     */
    public void addValue(Field field, boolean mayMatch, Object actualValue, short valueType, ShortList itemValueType);

    
Since the valueStore will have access to an error reporter, this
allows it to be called appropriately.

Params:
  • key –  the key of the localized error message
  • args –  the list of arguments for substitution.
/**
     * Since the valueStore will have access to an error reporter, this
     * allows it to be called appropriately.
     * @param key  the key of the localized error message
     * @param args  the list of arguments for substitution.
     */
    public void reportError(String key, Object[] args);
    

} // interface ValueStore