PSVIProvider


1   /*
2    * The Apache Software License, Version 1.1
3    *
4    *
5    * Copyright (c) 2001, 2002 The Apache Software Foundation.  All rights
6    * reserved.
7    *
8    * Redistribution and use in source and binary forms, with or without
9    * modification, are permitted provided that the following conditions
10   * are met:
11   *
12   * 1. Redistributions of source code must retain the above copyright
13   *    notice, this list of conditions and the following disclaimer.
14   *
15   * 2. Redistributions in binary form must reproduce the above copyright
16   *    notice, this list of conditions and the following disclaimer in
17   *    the documentation and/or other materials provided with the
18   *    distribution.
19   *
20   * 3. The end-user documentation included with the redistribution,
21   *    if any, must include the following acknowledgment:
22   *       "This product includes software developed by the
23   *        Apache Software Foundation (http://www.apache.org/)."
24   *    Alternately, this acknowledgment may appear in the software itself,
25   *    if and wherever such third-party acknowledgments normally appear.
26   *
27   * 4. The names "Xerces" and "Apache Software Foundation" must
28   *    not be used to endorse or promote products derived from this
29   *    software without prior written permission. For written
30   *    permission, please contact apache@apache.org.
31   *
32   * 5. Products derived from this software may not be called "Apache",
33   *    nor may "Apache" appear in their name, without prior written
34   *    permission of the Apache Software Foundation.
35   *
36   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47   * SUCH DAMAGE.
48   * ====================================================================
49   *
50   * This software consists of voluntary contributions made by many
51   * individuals on behalf of the Apache Software Foundation and was
52   * originally based on software copyright (c) 2001, International
53   * Business Machines, Inc., http://www.apache.org.  For more
54   * information on the Apache Software Foundation, please see
55   * <http://www.apache.org/>.
56   */
57  package com.sun.org.apache.xerces.internal.impl.xs.psvi;
58  
59  import com.sun.org.apache.xerces.internal.xni.psvi.AttributePSVI;
60  import com.sun.org.apache.xerces.internal.xni.psvi.ElementPSVI;
61  
62  /**
63   * This interface provides access to the post schema validation infoset for an 
64   * API that provides streaming document infoset, such as SAX, XNI, and 
65   * others. 
66   * <p>For implementations that would like to provide access to the PSVI in a 
67   * streaming model, a parser object should also implement 
68   * <code>PSVIProvider</code> interface. Within the scope of the methods 
69   * handling the start and end of an element, applications may use the 
70   * <code>PSVIProvider</code> to retrieve the PSVI related to that element 
71   * and its attributes.
72   * The interface may be updated or replaced. 
73   */
74  public interface PSVIProvider {
75      /**
76       * Provides the post schema validation item for the current element 
77       * information item. The method must be called by an application while 
78       * in the scope of a document handler start/end element calls. If this 
79       * methods is called from other document handler methods, the return 
80       * value is undefined. 
81       * @return The post schema validation infoset for the current element. If 
82       *   an element information item is valid then in the 
83       *   post-schema-validation infoset the following properties must be 
84       *   available for the element information item: The following 
85       *   properties are available in the scope of a document handler 
86       *   <code>startElement</code>: {element declaration}, {validation 
87       *   context}, {notation}. The {schema information} property is 
88       *   available for the validation root. The {error codes} property is 
89       *   available if any errors occured during validation.  The following 
90       *   properties are available in the scope of a document handler 
91       *   <code>endElement</code>: {nil}, {schema specified}, {normalized 
92       *   value},{ member type definition}, {validity}, {validation attempted}
93       *   . If the declaration has a value constraint, the property {schema 
94       *   default} is available. The {error codes} property is available if 
95       *   any errors occured during validation. Note: some processors may 
96       *   choose to provide all the PSVI properties in the scope of the 
97       *   <code>endElement</code>. 
98       */
99      public ElementPSVI getElementPSVI();
100 
101     /**
102      * Provides <code>AttributePSVI</code> given the index of an attribute 
103      * information item in the current element's attribute list. The method 
104      * must be called by an application while in the scope of a document 
105      * handler <code>startElement</code> call.
106      * @param index The attribute index 
107      * @return The post schema validation properties of the attribute.
108      */
109     public AttributePSVI getAttributePSVI(int index);
110 
111     /**
112      * Provides <code>AttributePSVI</code> given namespace and localname of an 
113      * attribute information item in the current element's attribute list. 
114      * The method must be called by an application while in the scope of a 
115      * document handler <code>startElement</code> call.
116      * @param uri The namespace of an attribute 
117      * @param localname The local name of an attribute 
118      * @return The post schema validation properties of the attribute.
119      */
120     public AttributePSVI getAttributePSVIByName(String   uri, 
121                                                 String   localname);
122 
123 }
124
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags