1 /*
2
3 stax Stack API for XML.
4 Copyright (c) 2001-2006 held jointly by the individual authors.
5
6 This library is free software; you can redistribute it and/or modify it
7 under the terms of the GNU Lesser General Public License as published
8 by the Free Software Foundation; either version 2.1 of the License, or (at
9 your option) any later version.
10
11 This library is distributed in the hope that it will be useful, but WITHOUT
12 ANY WARRANTY; with out even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
14 License for more details.
15
16 You should have received a copy of the GNU Lesser General Public License
17 along with this library; if not, write to the Free Software Foundation,
18 Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
19
20 > http://www.gnu.org/copyleft/lesser.html
21 > http://www.opensource.org/licenses/lgpl-license.php
22
23 */
24 package net.sf.stax;
25
26 import java.util.List;
27
28 import org.xml.sax.Locator;
29
30 /***
31 * Interface which exposes id mapping services offered by a StAX event source.
32 *
33 * @author Thomas Down
34 * @author Matthew Pocock
35 * @author Michael Heuer
36 * @version $Revision: 1.3 $ $Date: 2006/01/02 20:37:34 $
37 */
38 public interface StAXContext
39 {
40
41 /***
42 * Return the IdMapper implementation associated with
43 * this context.
44 *
45 * @return the IdMapper implementation associated with
46 * this context
47 */
48 IdMapper getIdMapper();
49
50 /***
51 * Return a list of contexts.
52 *
53 * @return a list of contexts
54 */
55 List getContexts();
56
57 /***
58 * Return the document locator associated with this context.
59 * May be null.
60 *
61 * @return the document locator associated with this context
62 */
63 Locator getLocator();
64
65 /***
66 * Set the document locator associated with this context to <code>locator</code>.
67 *
68 * @param locator document locator
69 */
70 void setLocator(Locator locator);
71 }