Source Code Cross Referenced for Locator.java in  » Development » Javolution » org » xml » sax » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Development » Javolution » org.xml.sax 
Source Cross Referenced  Class Diagram Java Document (Java Doc) 


001:        // SAX locator interface for document events.
002:        // http://www.saxproject.org
003:        // No warranty; no copyright -- use this as you will.
004:
005:        package org.xml.sax;
006:
007:        /**
008:         * Interface for associating a SAX event with a document location.
009:         *
010:         * <blockquote>
011:         * <em>This module, both source code and documentation, is in the
012:         * Public Domain, and comes with <strong>NO WARRANTY</strong>.</em>
013:         * See <a href='http://www.saxproject.org'>http://www.saxproject.org</a>
014:         * for further information.
015:         * </blockquote>
016:         *
017:         * <p>If a SAX parser provides location information to the SAX
018:         * application, it does so by implementing this interface and then
019:         * passing an instance to the application using the content
020:         * handler's {@link org.xml.sax.ContentHandler#setDocumentLocator
021:         * setDocumentLocator} method.  The application can use the
022:         * object to obtain the location of any other SAX event
023:         * in the XML source document.</p>
024:         *
025:         * <p>Note that the results returned by the object will be valid only
026:         * during the scope of each callback method: the application
027:         * will receive unpredictable results if it attempts to use the
028:         * locator at any other time, or after parsing completes.</p>
029:         *
030:         * <p>SAX parsers are not required to supply a locator, but they are
031:         * very strongly encouraged to do so.  If the parser supplies a
032:         * locator, it must do so before reporting any other document events.
033:         * If no locator has been set by the time the application receives
034:         * the {@link org.xml.sax.ContentHandler#startDocument startDocument}
035:         * event, the application should assume that a locator is not 
036:         * available.</p>
037:         *
038:         * @since SAX 1.0
039:         * @author David Megginson
040:         * @version 2.0.1 (sax2r2)
041:         * @see org.xml.sax.ContentHandler#setDocumentLocator 
042:         */
043:        public interface Locator {
044:
045:            /**
046:             * Return the public identifier for the current document event.
047:             *
048:             * <p>The return value is the public identifier of the document
049:             * entity or of the external parsed entity in which the markup
050:             * triggering the event appears.</p>
051:             *
052:             * @return A string containing the public identifier, or
053:             *         null if none is available.
054:             * @see #getSystemId
055:             */
056:            public abstract String getPublicId();
057:
058:            /**
059:             * Return the system identifier for the current document event.
060:             *
061:             * <p>The return value is the system identifier of the document
062:             * entity or of the external parsed entity in which the markup
063:             * triggering the event appears.</p>
064:             *
065:             * <p>If the system identifier is a URL, the parser must resolve it
066:             * fully before passing it to the application.  For example, a file
067:             * name must always be provided as a <em>file:...</em> URL, and other
068:             * kinds of relative URI are also resolved against their bases.</p>
069:             *
070:             * @return A string containing the system identifier, or null
071:             *         if none is available.
072:             * @see #getPublicId
073:             */
074:            public abstract String getSystemId();
075:
076:            /**
077:             * Return the line number where the current document event ends.
078:             * Lines are delimited by line ends, which are defined in
079:             * the XML specification.
080:             *
081:             * <p><strong>Warning:</strong> The return value from the method
082:             * is intended only as an approximation for the sake of diagnostics;
083:             * it is not intended to provide sufficient information
084:             * to edit the character content of the original XML document.
085:             * In some cases, these "line" numbers match what would be displayed
086:             * as columns, and in others they may not match the source text
087:             * due to internal entity expansion.  </p>
088:             *
089:             * <p>The return value is an approximation of the line number
090:             * in the document entity or external parsed entity where the
091:             * markup triggering the event appears.</p>
092:             *
093:             * <p>If possible, the SAX driver should provide the line position 
094:             * of the first character after the text associated with the document 
095:             * event.  The first line is line 1.</p>
096:             *
097:             * @return The line number, or -1 if none is available.
098:             * @see #getColumnNumber
099:             */
100:            public abstract int getLineNumber();
101:
102:            /**
103:             * Return the column number where the current document event ends.
104:             * This is one-based number of Java <code>char</code> values since
105:             * the last line end.
106:             *
107:             * <p><strong>Warning:</strong> The return value from the method
108:             * is intended only as an approximation for the sake of diagnostics;
109:             * it is not intended to provide sufficient information
110:             * to edit the character content of the original XML document.
111:             * For example, when lines contain combining character sequences, wide
112:             * characters, surrogate pairs, or bi-directional text, the value may
113:             * not correspond to the column in a text editor's display. </p>
114:             *
115:             * <p>The return value is an approximation of the column number
116:             * in the document entity or external parsed entity where the
117:             * markup triggering the event appears.</p>
118:             *
119:             * <p>If possible, the SAX driver should provide the line position 
120:             * of the first character after the text associated with the document 
121:             * event.  The first column in each line is column 1.</p>
122:             *
123:             * @return The column number, or -1 if none is available.
124:             * @see #getLineNumber
125:             */
126:            public abstract int getColumnNumber();
127:
128:        }
129:
130:        // end of Locator.java
www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.