View Javadoc
1 package org.apache.turbine.util; 2 3 /* ==================================================================== 4 * The Apache Software License, Version 1.1 5 * 6 * Copyright (c) 2001 The Apache Software Foundation. All rights 7 * reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in 18 * the documentation and/or other materials provided with the 19 * distribution. 20 * 21 * 3. The end-user documentation included with the redistribution, 22 * if any, must include the following acknowledgment: 23 * "This product includes software developed by the 24 * Apache Software Foundation (http://www.apache.org/)." 25 * Alternately, this acknowledgment may appear in the software itself, 26 * if and wherever such third-party acknowledgments normally appear. 27 * 28 * 4. The names "Apache" and "Apache Software Foundation" and 29 * "Apache Turbine" must not be used to endorse or promote products 30 * derived from this software without prior written permission. For 31 * written permission, please contact apache@apache.org. 32 * 33 * 5. Products derived from this software may not be called "Apache", 34 * "Apache Turbine", nor may "Apache" appear in their name, without 35 * prior written permission of the Apache Software Foundation. 36 * 37 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED 38 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 39 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 40 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR 41 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 42 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 43 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 44 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 45 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 46 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 47 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 48 * SUCH DAMAGE. 49 * ==================================================================== 50 * 51 * This software consists of voluntary contributions made by many 52 * individuals on behalf of the Apache Software Foundation. For more 53 * information on the Apache Software Foundation, please see 54 * <http://www.apache.org/>;. 55 */ 56 57 import java.io.Reader; 58 import java.io.StreamTokenizer; 59 import java.util.List; 60 61 /*** 62 * TSVParser is used to parse a stream with tab-separated values and 63 * generate ParameterParser objects which can be used to 64 * extract the values in the desired type. 65 * 66 * <p>The class extends the abstract class DataStreamParser and implements 67 * initTokenizer with suitable values for TSV files to provide this 68 * functionality. 69 * 70 * <p>The class (indirectly through DataStreamParser) implements the 71 * java.util.Iterator interface for convenience. 72 * This allows simple use in a Velocity template for example: 73 * 74 * <pre> 75 * #foreach ($row in $tsvfile) 76 * Name: $row.Name 77 * Description: $row.Description 78 * #end 79 * </pre> 80 * 81 * @author <a href="mailto:sean@informage.net">Sean Legassick</a> 82 * @author <a href="mailto:martin@mvdb.net">Martin van den Bemt</a> 83 * @version $Id: TSVParser.java,v 1.2 2002/05/29 13:38:26 brekke Exp $ 84 */ 85 public class TSVParser extends DataStreamParser 86 { 87 /*** 88 * Create a new TSVParser instance. Requires a Reader to read the 89 * tab-separated values from. The column headers must be set 90 * independently either explicitly, or by reading the first line 91 * of the TSV values. 92 * 93 * @param in the input reader. 94 */ 95 public TSVParser(Reader in) 96 { 97 super(in, null, null); 98 } 99 100 /*** 101 * Create a new TSVParser instance. Requires a Reader to read the 102 * tab-separated values from, and a list of column names. 103 * 104 * @param in the input reader. 105 * @param columnNames a list of column names. 106 */ 107 public TSVParser(Reader in, List columnNames) 108 { 109 super(in, columnNames, null); 110 } 111 112 /*** 113 * Create a new TSVParser instance. Requires a Reader to read the 114 * tab-separated values from, a list of column names and a 115 * character encoding. 116 * 117 * @param in the input reader. 118 * @param columnNames a list of column names. 119 * @param characterEncoding the character encoding of the input. 120 */ 121 public TSVParser(Reader in, List columnNames, String characterEncoding) 122 { 123 super(in, columnNames, characterEncoding); 124 } 125 126 /*** 127 * Initialize the StreamTokenizer instance used to read the lines 128 * from the input reader. 129 * It is now only needed to set the fieldSeparator 130 */ 131 protected void initTokenizer(StreamTokenizer tokenizer) 132 { 133 super.initTokenizer(tokenizer); 134 // set the field separator to tabs. 135 super.setFieldSeparator('\t'); 136 } 137 }

This page was automatically generated by Maven