/*
 * Copyright (c) 2016, Metron, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of Metron, Inc. nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL METRON, INC. BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.metsci.glimpse.dspl.parser;

import java.io.IOException;
import java.io.InputStream;
import java.nio.channels.ReadableByteChannel;

import javax.xml.bind.JAXBException;

import com.metsci.glimpse.dspl.parser.table.PropertyTableData;
import com.metsci.glimpse.dspl.parser.table.SliceTableData;
import com.metsci.glimpse.dspl.schema.Concept;
import com.metsci.glimpse.dspl.schema.Slice;
import com.metsci.glimpse.dspl.util.DsplException;

/**
 * DSPL supports data in multiple formats. Each new format requires an implementation of TableParser which
 * can read data files and output a TableData containing the data stored in the file.
 *
 * @author ulman
 *
 */
public interface TableParser
{
    public SliceTableData parse( Slice slice ) throws IOException, JAXBException, DsplException;

    public PropertyTableData parse( Concept concept ) throws IOException, JAXBException, DsplException;

    public SliceTableData parse( Slice slice, InputStream in ) throws IOException, JAXBException, DsplException;

    public PropertyTableData parse( Concept concept, InputStream in ) throws IOException, JAXBException, DsplException;

    public SliceTableData parse( Slice slice, ReadableByteChannel in ) throws IOException, JAXBException, DsplException;

    public PropertyTableData parse( Concept concept, ReadableByteChannel in ) throws IOException, JAXBException, DsplException;

    public boolean isCachable( );
}