001    /* EVolve - an Extensible Software Visualization Framework
002     * Copyright (C) 2001-2002 Qin Wang
003     *
004     * This library is free software; you can redistribute it and/or
005     * modify it under the terms of the GNU Library General Public
006     * License as published by the Free Software Foundation; either
007     * version 2 of the License, or (at your option) any later version.
008     *
009     * This library is distributed in the hope that it will be useful,
010     * but WITHOUT ANY WARRANTY; without even the implied warranty of
011     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
012     * Library General Public License for more details.
013     *
014     * You should have received a copy of the GNU Library General Public
015     * License along with this library; if not, write to the
016     * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
017     * Boston, MA 02111-1307, USA.
018     */
019    
020    /*
021     * EVolve is distributed at http://www.sable.mcgill.ca/EVolve/
022     */
023    
024    package EVolve.data;
025    
026    /**
027     * EVolve data source.
028     */
029    public interface DataSource {
030        /**
031         * Initializes the data source.
032         */
033        public void init() throws DataProcessingException;
034    
035        /**
036         * Starts building the element definitions.
037         */
038        public void startBuildDefinition() throws DataProcessingException;
039    
040        /**
041         * Gets the next element definition.
042         *
043         * @return  next element definition, null if all the definitions are sent.
044         */
045        public ElementDefinition getNextDefinition() throws DataProcessingException;
046    
047        /**
048         * Starts building the entities.
049         */
050        public void startBuildEntity() throws DataProcessingException;
051    
052        /**
053         * Gets the next entity.
054         *
055         * @return  next entity, null if all the entities are sent.
056         */
057        public Entity getNextEntity() throws DataProcessingException;
058    
059        /**
060         * Starts building the events.
061         */
062        public void startBuildEvent() throws DataProcessingException;
063    
064        /**
065         * Gets the next event.
066         *
067         * @return  next event, null if all the events are sent.
068         */
069        public Event getNextEvent() throws DataProcessingException;
070    
071    }