001/*
002 * Copyright (c) 1998-2012 The Regents of the University of California.
003 * All rights reserved.
004 *
005 * '$Author: barseghian $'
006 * '$Date: 2012-04-27 13:16:27 -0700 (Fri, 27 Apr 2012) $' 
007 * '$Revision: 29789 $'
008 * 
009 * Permission is hereby granted, without written agreement and without
010 * license or royalty fees, to use, copy, modify, and distribute this
011 * software and its documentation for any purpose, provided that the above
012 * copyright notice and the following two paragraphs appear in all copies
013 * of this software.
014 *
015 * IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
016 * FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
017 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
018 * THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
019 * SUCH DAMAGE.
020 *
021 * THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
022 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
023 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
024 * PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
025 * CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
026 * ENHANCEMENTS, OR MODIFICATIONS.
027 *
028 */
029package org.kepler.metadata;
030
031import java.util.List;
032
033import org.kepler.objectmanager.data.db.Entity;
034import org.xml.sax.InputSource;
035
036/**
037 * A metadata parser will be used in the MetadataPaser actor.
038 * @author tao
039 *
040 */
041public interface ParserInterface {
042  
043  /**
044   * parses the EML package using an InputSource
045   */
046  public void parse(InputSource source) throws Exception;
047  /**
048   * Get a collection of the Entity objects.
049   * @return the collection of entities.
050   */
051  public List<Entity> getEntities();
052  
053  /**
054   * returns the total number of entities in the data item collection that was
055   * passed to this class when the object was created.
056   */
057  public int getEntityCount();
058}