Parser.java revision 56ed4167b942ec265f9cee70ac4d71d10b3835ce
156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson/* 256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * Copyright (C) 2010 Google Inc. 356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * 456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * Licensed under the Apache License, Version 2.0 (the "License"); 556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * you may not use this file except in compliance with the License. 656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * You may obtain a copy of the License at 756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * 856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * http://www.apache.org/licenses/LICENSE-2.0 956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * 1056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * Unless required by applicable law or agreed to in writing, software 1156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * distributed under the License is distributed on an "AS IS" BASIS, 1256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 1356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * See the License for the specific language governing permissions and 1456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * limitations under the License. 1556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson */ 1656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 1756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonpackage com.google.clearsilver.jsilver.data; 1856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 1956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport com.google.clearsilver.jsilver.resourceloader.ResourceLoader; 2056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 2156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport java.io.Reader; 2256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport java.io.IOException; 2356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 2456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson/** 2556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * Parses data in HierachicalDataFormat (HDF), generating callbacks for data encountered in the 2656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * stream. 2756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson */ 2856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonpublic interface Parser { 2956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 3056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson /** Called whenever an error occurs. */ 3156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public interface ErrorHandler { 3256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson /** 3356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * Report an error to the ErrorHandler. 3456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * 3556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * @param line number of the line where error occurred. The value of -1 represents line number 3656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * unknown 3756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * @param lineContent text of the line with error 3856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * @param fileName name of the file in which the error occurred 3956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * @param errorMessage description of an error 4056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson */ 4156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson void error(int line, String lineContent, String fileName, String errorMessage); 4256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 4356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 4456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson /** 4556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * Reads in a stream of characters and parses data from it, putting it into the given Data object. 4656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * 4756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * @param reader Reader used to read in the formatted data. 4856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * @param output Data object that the read data structure will be dumped into. 4956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * @param errorHandler Error callback to be called on any error. 5056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * @param resourceLoader ResourceLoader to use to read in included files. 5156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * @param dataFileName Name of a file that is read with reader. It is needed for the purpose of 5256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * handling include loops and error messages. 5356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * @param ignoreAttributes whether to store parsed HDF attributes in the Data object or not. 5456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * @throws IOException when errors occur reading input. 5556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson */ 5656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson void parse(Reader reader, Data output, ErrorHandler errorHandler, ResourceLoader resourceLoader, 5756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson String dataFileName, boolean ignoreAttributes) throws IOException; 5856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson} 59