001    /*
002     * mesopotamia @mesopotamia.version@
003     * Multilingual parser and repository. 
004     * Copyright (C) 2005  Hammurapi Group
005     *
006     * This program is free software; you can redistribute it and/or
007     * modify it under the terms of the GNU Lesser General Public
008     * License as published by the Free Software Foundation; either
009     * version 2 of the License, or (at your option) any later version.
010     *
011     * This program is distributed in the hope that it will be useful,
012     * but WITHOUT ANY WARRANTY; without even the implied warranty of
013     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014     * Lesser General Public License for more details.
015     *
016     * You should have received a copy of the GNU Lesser General Public
017     * License along with this library; if not, write to the Free Software
018     * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
019     *
020     * URL: http://http://www.hammurapi.biz
021     * e-Mail: support@hammurapi.biz
022     */
023    package org.mesopotamia;
024    
025    import java.security.MessageDigest;
026    
027    /**
028     * Source for parsing.
029     * @author Pavel Vlasov
030     * @revision $Revision: 1.2 $
031     */
032    public interface Source {
033            
034            /**
035             * @return source size
036             */
037            long getSize();
038            
039            /**
040             * @param Message digest instance
041             * @return source digest
042             */
043            String getDigest(MessageDigest digest) throws MesopotamiaException;
044            
045            //long getTimestamp();
046            
047            /**
048             * @return Relative source path in repository hierarchy
049             */
050            String getPath();
051            
052            /**
053             * @return Source name
054             */
055            String getName();
056            
057            /**
058             * @return Underlying source object e.g. java.io.File, Dom document, ...
059             */
060            Object get();
061            
062            /**
063             * @return last modification time.
064             */
065            long getLastModified();
066    }