View Javadoc

1   /*
2    * ModeShape (http://www.modeshape.org)
3    * See the COPYRIGHT.txt file distributed with this work for information
4    * regarding copyright ownership.  Some portions may be licensed
5    * to Red Hat, Inc. under one or more contributor license agreements.
6    * See the AUTHORS.txt file in the distribution for a full listing of 
7    * individual contributors.
8    *
9    * ModeShape is free software. Unless otherwise indicated, all code in ModeShape
10   * is licensed to you under the terms of the GNU Lesser General Public License as
11   * published by the Free Software Foundation; either version 2.1 of
12   * the License, or (at your option) any later version.
13   * 
14   * ModeShape is distributed in the hope that it will be useful,
15   * but WITHOUT ANY WARRANTY; without even the implied warranty of
16   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17   * Lesser General Public License for more details.
18   *
19   * You should have received a copy of the GNU Lesser General Public
20   * License along with this software; if not, write to the Free
21   * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
22   * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
23   */
24  package org.modeshape.sequencer.text;
25  
26  import net.jcip.annotations.NotThreadSafe;
27  import org.modeshape.graph.sequencer.SequencerOutput;
28  import org.modeshape.graph.sequencer.StreamSequencer;
29  import org.modeshape.graph.sequencer.StreamSequencerContext;
30  
31  /**
32   * A simple interface that allows an implementer to control how rows in a text file are mapped to properties (including primary
33   * and mixin types) in the graph.
34   * <p>
35   * Implementations of this class must provide a public, no-argument constructor.
36   * </p>
37   * <p>
38   * To use, supply the implementation class name to a {@link AbstractTextSequencer} object. New instances are created for each
39   * {@link StreamSequencer#sequence(java.io.InputStream, SequencerOutput, StreamSequencerContext)}, so implementations of this
40   * interface need not be thread-safe.
41   * </p>
42   */
43  @NotThreadSafe
44  public interface RowFactory {
45  
46      /**
47       * Records a row using the provided {@link SequencerOutput} instance.
48       * 
49       * @param context the sequencer context
50       * @param output the {@link StreamSequencer} output
51       * @param columns the columns that could be parsed out for the row
52       */
53      void recordRow( StreamSequencerContext context,
54                   SequencerOutput output,
55                   String[] columns );
56  
57  }