KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > ws > jaxme > xs > parser > XSContext


1 /*
2  * Copyright 2003, 2004 The Apache Software Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15
16  */
17 package org.apache.ws.jaxme.xs.parser;
18
19 import org.apache.ws.jaxme.xs.*;
20 import org.apache.ws.jaxme.xs.impl.XSLogicalParser;
21 import org.apache.ws.jaxme.xs.xml.XsObjectFactory;
22 import org.xml.sax.ContentHandler JavaDoc;
23 import org.xml.sax.Locator JavaDoc;
24 import org.xml.sax.helpers.NamespaceSupport JavaDoc;
25
26 /** <p>This interface provides access to the parsers context.</p>
27  *
28  * @author <a HREF="mailto:joe@ispsoft.de">Jochen Wiedmann</a>
29  */
30 public interface XSContext {
31   /** <p>Returns the parsers object factory for syntax elements.</p>
32    */
33   public XsObjectFactory getXsObjectFactory();
34   /** <p>Sets the parsers object factory for syntax elements.</p>
35    */
36   public void setXsObjectFactory(XsObjectFactory pFactory);
37
38   /** <p>Returns the parsers object factory for logical elements.</p>
39    */
40   public XSObjectFactory getXSObjectFactory();
41   /** <p>Sets the parsers object factory for logical elements.</p>
42    */
43   public void setXSObjectFactory(XSObjectFactory pFactory);
44
45   /** <p>Returns the {@link AttributeSetter}, which is used to
46    * configure properties.</p>
47    */
48   public AttributeSetter getAttributeSetter();
49   /** <p>Sets the AttributeSetter, which is used to
50    * configure properties.</p>
51    */
52   public void setAttributeSetter(AttributeSetter pSetter);
53
54   /** <p>Returns the {@link ChildSetter}, which is used to create
55    * child elements.</p>
56    */
57   public ChildSetter getChildSetter();
58   /** <p>Sets the ChildSetter, which is used to create
59    * child elements.</p>
60    */
61   public void setChildSetter(ChildSetter pSetter);
62
63   /** <p>Returns the {@link TextSetter}, used to add text sections.</p>
64    */
65   public TextSetter getTextSetter();
66   /** <p>Sets the TextSetter, used to add text sections.</p>
67    */
68   public void setTextSetter(TextSetter pSetter);
69
70   /** <p>Returns the currently running {@link XSParser} or null,
71    * if no such instance is available.</p>
72    */
73   public XSLogicalParser getXSLogicalParser();
74   /** <p>Sets the currently active instance of {@link XSParser}, if any.
75    * Returns null, if no such instance is available.</p>
76    */
77   public void setXSLogicalParser(XSLogicalParser pParser);
78
79   /** <p>Returns the {@link XSSchema}, which is currently being parsed,
80    * if any.</p>
81    */
82   public XSSchema getXSSchema();
83
84   /** <p>Returns the locator, used for error messages.</p>
85    */
86   public Locator JavaDoc getLocator();
87   /** <p>Sets the locator, used for error messages.</p>
88    */
89   public void setLocator(Locator JavaDoc pLocator);
90
91   /** <p>Returns the namespace handler.</p>
92    */
93   public NamespaceSupport JavaDoc getNamespaceSupport();
94   /** <p>Sets the namespace handler.</p>
95    */
96   public void setNamespaceSupport(NamespaceSupport JavaDoc pNamespaceSupport);
97
98   /** <p>Sets the currently active instance of {@link XsSAXParser}.</p>
99    */
100   public ContentHandler JavaDoc getCurrentContentHandler();
101   /** <p>Sets the currently active instance of {@link XsSAXParser}.</p>
102    */
103   public void setCurrentContentHandler(ContentHandler JavaDoc pParser);
104 }
Popular Tags