001    /*
002     * JBoss DNA (http://www.jboss.org/dna)
003     * See the COPYRIGHT.txt file distributed with this work for information
004     * regarding copyright ownership.  Some portions may be licensed
005     * to Red Hat, Inc. under one or more contributor license agreements.
006    * See the AUTHORS.txt file in the distribution for a full listing of 
007    * individual contributors.
008     *
009     * JBoss DNA is free software. Unless otherwise indicated, all code in JBoss DNA
010     * is licensed to you under the terms of the GNU Lesser General Public License as
011     * published by the Free Software Foundation; either version 2.1 of
012     * the License, or (at your option) any later version.
013     *
014     * JBoss DNA is distributed in the hope that it will be useful,
015     * but WITHOUT ANY WARRANTY; without even the implied warranty of
016     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
017     * Lesser General Public License for more details.
018     *
019     * You should have received a copy of the GNU Lesser General Public
020     * License along with this software; if not, write to the Free
021     * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
022     * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
023     */
024    package org.jboss.dna.graph.sequencers;
025    
026    import java.sql.Connection;
027    import org.jboss.dna.graph.sequencer.SequencerContext;
028    import org.jboss.dna.graph.sequencer.SequencerOutput;
029    
030    /**
031     * The interface for a DNA sequencer that processes a JDBC connection (for instance, JDBC Metadata) and stores in the repository.
032     * <p>
033     * Implementations must provide a no-argument constructor.
034     * </p>
035     * 
036     * @author <a href="mailto:litsenko_sergey@yahoo.com">Sergiy Litsenko</a>
037     */
038    public interface JdbcSequencer {
039    
040        /**
041         * Sequence the data found in the a JDBC connection (for instance, JDBC Metadata).
042         * 
043         * @param connection the JDBC connection to be sequenced; never <code>null</code>
044         * @param output the output from the sequencing operation; never <code>null</code>
045         * @param context the context for the sequencing operation; never <code>null</code>
046         */
047        void sequence( Connection connection,
048                       SequencerOutput output,
049                       SequencerContext context );
050    }