Source Code Cross Referenced for CharStream.java in  » Net » lucene-connector » org » apache » lucene » queryParser » 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 » Net » lucene connector » org.apache.lucene.queryParser 
Source Cross Referenced  Class Diagram Java Document (Java Doc) 


001:        /* Generated By:JavaCC: Do not edit this line. CharStream.java Version 3.0 */
002:        package org.apache.lucene.queryParser;
003:
004:        /**
005:         * This interface describes a character stream that maintains line and
006:         * column number positions of the characters.  It also has the capability
007:         * to backup the stream to some extent.  An implementation of this
008:         * interface is used in the TokenManager implementation generated by
009:         * JavaCCParser.
010:         *
011:         * All the methods except backup can be implemented in any fashion. backup
012:         * needs to be implemented correctly for the correct operation of the lexer.
013:         * Rest of the methods are all used to get information like line number,
014:         * column number and the String that constitutes a token and are not used
015:         * by the lexer. Hence their implementation won't affect the generated lexer's
016:         * operation.
017:         */
018:
019:        public interface CharStream {
020:
021:            /**
022:             * Returns the next character from the selected input.  The method
023:             * of selecting the input is the responsibility of the class
024:             * implementing this interface.  Can throw any java.io.IOException.
025:             */
026:            char readChar() throws java.io.IOException;
027:
028:            /**
029:             * Returns the column position of the character last read.
030:             * @deprecated 
031:             * @see #getEndColumn
032:             */
033:            int getColumn();
034:
035:            /**
036:             * Returns the line number of the character last read.
037:             * @deprecated 
038:             * @see #getEndLine
039:             */
040:            int getLine();
041:
042:            /**
043:             * Returns the column number of the last character for current token (being
044:             * matched after the last call to BeginTOken).
045:             */
046:            int getEndColumn();
047:
048:            /**
049:             * Returns the line number of the last character for current token (being
050:             * matched after the last call to BeginTOken).
051:             */
052:            int getEndLine();
053:
054:            /**
055:             * Returns the column number of the first character for current token (being
056:             * matched after the last call to BeginTOken).
057:             */
058:            int getBeginColumn();
059:
060:            /**
061:             * Returns the line number of the first character for current token (being
062:             * matched after the last call to BeginTOken).
063:             */
064:            int getBeginLine();
065:
066:            /**
067:             * Backs up the input stream by amount steps. Lexer calls this method if it
068:             * had already read some characters, but could not use them to match a
069:             * (longer) token. So, they will be used again as the prefix of the next
070:             * token and it is the implemetation's responsibility to do this right.
071:             */
072:            void backup(int amount);
073:
074:            /**
075:             * Returns the next character that marks the beginning of the next token.
076:             * All characters must remain in the buffer between two successive calls
077:             * to this method to implement backup correctly.
078:             */
079:            char BeginToken() throws java.io.IOException;
080:
081:            /**
082:             * Returns a string made up of characters from the marked token beginning 
083:             * to the current buffer position. Implementations have the choice of returning
084:             * anything that they want to. For example, for efficiency, one might decide
085:             * to just return null, which is a valid implementation.
086:             */
087:            String GetImage();
088:
089:            /**
090:             * Returns an array of characters that make up the suffix of length 'len' for
091:             * the currently matched token. This is used to build up the matched string
092:             * for use in actions in the case of MORE. A simple and inefficient
093:             * implementation of this is as follows :
094:             *
095:             *   {
096:             *      String t = GetImage();
097:             *      return t.substring(t.length() - len, t.length()).toCharArray();
098:             *   }
099:             */
100:            char[] GetSuffix(int len);
101:
102:            /**
103:             * The lexer calls this function to indicate that it is done with the stream
104:             * and hence implementations can free any resources held by this class.
105:             * Again, the body of this function can be just empty and it will not
106:             * affect the lexer's operation.
107:             */
108:            void Done();
109:
110:        }
www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.