/* Copyright (c) 2005 Ricebridge. All Rights Reserved.
 *
 * This file is available under the terms and conditions of the
 * Ricebridge "Open Source API" policy; Ricebridge grants use of this
 * copyrighted work under the terms of a BSD-style license only. See
 * http://www.opensource.org/licenses/bsd-license.php for more
 * information.
 * 
 * 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 the Ricebridge 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 THE
 * COPYRIGHT OWNER OR CONTRIBUTORS 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.ricebridge.xmlman.test;


import com.ricebridge.xmlman.*;
import com.ricebridge.xmlman.in.*;
import com.ricebridge.xmlman.in.test.*;
import com.ricebridge.xmlman.log.*;

import org.jostraca.util.*;

import junit.framework.*;
import junit.textui.*;

import org.xml.sax.InputSource;

import javax.xml.parsers.SAXParserFactory;
import javax.xml.parsers.SAXParser;

import javax.swing.table.TableModel;

import java.util.*;
import java.io.*;


/** Test cases for {@link com.ricebridge.xmlman.XmlManager} TableModel handling.
 *    <p>Test files are <a href="load.xml">load.xml</a>, <a href="load02.xml">load02.xml</a>, <a href="load03.xml">load03.xml</a>
 *  and <a href="example.xml">example.xml</a>.</p>
 *    <p>The <b><a href="LoadTableModelTest.java.html">Source Code</a></b> of this Java class 
 *    is available under a <a href="http://www.opensource.org/licenses/bsd-license.php">BSD-style license</a>.</p>
 */
public class LoadTableModelTest extends TestCase {

  // test framework
  
  public LoadTableModelTest( String pName ) {
    super( pName );
  }

  public static TestSuite suite() {
    return new TestSuite( LoadTableModelTest.class );
  }

  public static void main( String[] pArgs ) {
    TestRunner.run( suite() );
  }



  // test cases

  public void testExample() throws Exception {
    File xmlFile = null;

    xmlFile = TestUtil.findFile( "com/ricebridge/xmlman/test/example.xml" );
    XmlManager xmlManager = new XmlManager();

    RecordSpec        rs         = new RecordSpec( "/root/record", 
                                                   new String[] {"@name","foo","bar"},
                                                   new String[] {"Name","Foo","Bar"} );
    TableModel         tm         = xmlManager.loadTableModel( xmlFile, rs );
    int                numCols    = tm.getColumnCount();
    int                numRows    = tm.getRowCount();

    StringBuffer sb = new StringBuffer();
    for( int col = 0; col < numCols; col++ ) {
      sb.append( tm.getColumnName(col) + (col<numCols-1?", ":"\n") );
    }
    sb.append( "---\n" );
    for( int row = 0; row < numRows; row++ ) {
      for( int col = 0; col < numCols; col++ ) {
        sb.append( tm.getValueAt(row,col) + (col<numCols-1?", ":"\n") );
      }
    }

    assertEquals( "Name, Foo, Bar\n---\nr1, f1, b1\nr2, f2, b2\nr3, f3, b3\n", sb.toString() );

    XmlSpec xs = xmlManager.getXmlSpec();
    xs.setProperty("TableModel.dataHasHeaders", true);
    tm  = xmlManager.loadTableModel( xmlFile, rs );
    assertEquals( "r2,f2,b2|r3,f3,b3|", canon(tm) );
    assertEquals( "r1,f1,b1,", heads(tm) );
  }


  public void testSingle() throws Exception {
    String loadcanon = "b1,q1|b2,q2|";
    String loadheads = "Name,Que,";

    File xmlFile = null;
    xmlFile = TestUtil.findFile( "com/ricebridge/xmlman/test/load.xml" );
    XmlManager xmlManager = new XmlManager();

    RecordSpec rs = new RecordSpec( "/foo/bar", 
                                    new String[] {"@name","que"},
                                    new String[] {"Name","Que"} );

    TableModel tm = xmlManager.loadTableModel( xmlFile, rs );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );

    tm = xmlManager.loadTableModel( xmlFile.getAbsolutePath(), rs );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );

    InputStream is = new FileInputStream( xmlFile );
    tm = xmlManager.loadTableModel( is, rs );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );
    is.close();

    InputStream fis  = new FileInputStream( xmlFile );
    InputSource isrc = new InputSource( fis );
    tm = xmlManager.loadTableModel( isrc, rs );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );
    fis.close();

    tm = xmlManager.loadTableModelFromURI( TestUtil.makeURI(xmlFile), rs );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );

    tm = xmlManager.loadTableModelFromString( FileUtil.readFile(xmlFile), rs );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );
  }


  public void testMultiple() throws Exception {
    String loadcanon = "b,b1,q1|b,b2,q2|f,f1,z1|";
    String loadheads = "Type,Name,Value,";

    File xmlFile = null;
    xmlFile = TestUtil.findFile( "com/ricebridge/xmlman/test/load.xml" );
    XmlManager xmlManager = new XmlManager();

    RecordSpec rs_b = new RecordSpec( "/foo/bar", 
                                      new String[] {"'b'","@name","que"},
                                      new String[] {"Type","Name","Value"} );
    RecordSpec rs_f = new RecordSpec( "/foo/far", 
                                      new String[] {"'f'","@name","zoo"},
                                      new String[] {"These","Headers","Ignored"} );

    RecordSpec rs = new RecordSpec( rs_b, rs_f );

    TableModel tm = xmlManager.loadTableModel( xmlFile, rs );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );

    tm = xmlManager.loadTableModel( xmlFile.getAbsolutePath(), rs );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );

    InputStream is = new FileInputStream( xmlFile );
    tm = xmlManager.loadTableModel( is, rs );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );
    is.close();

    InputStream fis  = new FileInputStream( xmlFile );
    InputSource isrc = new InputSource( fis );
    tm = xmlManager.loadTableModel( isrc, rs );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );
    fis.close();

    tm = xmlManager.loadTableModelFromURI( TestUtil.makeURI(xmlFile), rs );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );

    tm = xmlManager.loadTableModelFromString( FileUtil.readFile(xmlFile), rs );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );


    // prepared
    xmlManager = new XmlManager( rs );

    tm = xmlManager.loadTableModel( xmlFile );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );

    tm = xmlManager.loadTableModel( xmlFile.getAbsolutePath() );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );

    is = new FileInputStream( xmlFile );
    tm = xmlManager.loadTableModel( is );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );
    is.close();

    fis  = new FileInputStream( xmlFile );
    isrc = new InputSource( fis );
    tm = xmlManager.loadTableModel( isrc );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );
    fis.close();

    tm = xmlManager.loadTableModelFromURI( TestUtil.makeURI(xmlFile) );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );

    tm = xmlManager.loadTableModelFromString( FileUtil.readFile(xmlFile) );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );
  }


  public void testRepeat() throws Exception {
    String loadheads  = "Name,Que,";
    String fileprefix = "com/ricebridge/xmlman/test/";

    File xmlFile = null;
    xmlFile = TestUtil.findFile( fileprefix+"load.xml" );
    RecordSpec rs = new RecordSpec( "/foo/bar", 
                                    new String[] {"@name","que"},
                                    new String[] {"Name","Que"} );

    XmlManager xmlManager = new XmlManager(rs);

    String loadcanon1  = "b1,q1|b2,q2|";
    String loadcanon2  = "2b1,2q1|2b2,2q2|2b3,2q3|";
    String loadcanon3  = "3b1,3q1|3b2,3q2|3b3,3q3|3b4,3q4|";


    // file
    String loadcanon  = loadcanon1;
    TableModel tm = xmlManager.loadTableModel( xmlFile );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );
    assertEquals( 2, xmlManager.getStats().getTotalRecords() );

    tm = xmlManager.loadTableModel( xmlFile );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );
    assertEquals( 2, xmlManager.getStats().getTotalRecords() );

    loadcanon = loadcanon2;
    xmlFile = TestUtil.findFile( fileprefix+"load02.xml" );
    tm = xmlManager.loadTableModel( xmlFile );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );
    assertEquals( 3, xmlManager.getStats().getTotalRecords() );

    loadcanon = loadcanon3;
    xmlFile = TestUtil.findFile( fileprefix+"load03.xml" );
    tm = xmlManager.loadTableModel( xmlFile );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );
    assertEquals( 4, xmlManager.getStats().getTotalRecords() );


    // file path
    loadcanon  = loadcanon1;
    xmlFile = TestUtil.findFile( fileprefix+"load.xml" );
    tm = xmlManager.loadTableModel( xmlFile.getAbsolutePath() );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );
    assertEquals( 2, xmlManager.getStats().getTotalRecords() );

    tm = xmlManager.loadTableModel( xmlFile.getAbsolutePath() );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );
    assertEquals( 2, xmlManager.getStats().getTotalRecords() );

    loadcanon = loadcanon2;
    xmlFile = TestUtil.findFile( fileprefix+"load02.xml" );
    tm = xmlManager.loadTableModel( xmlFile.getAbsolutePath() );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );
    assertEquals( 3, xmlManager.getStats().getTotalRecords() );

    loadcanon = loadcanon3;
    xmlFile = TestUtil.findFile( fileprefix+"load03.xml" );
    tm = xmlManager.loadTableModel( xmlFile.getAbsolutePath() );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );
    assertEquals( 4, xmlManager.getStats().getTotalRecords() );


    // inputstream
    loadcanon  = loadcanon1;
    xmlFile = TestUtil.findFile( fileprefix+"load.xml" );
    InputStream is = new FileInputStream( xmlFile );
    tm = xmlManager.loadTableModel( is );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );
    assertEquals( 2, xmlManager.getStats().getTotalRecords() );
    is.close();

    is = new FileInputStream( xmlFile );
    tm = xmlManager.loadTableModel( is );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );
    assertEquals( 2, xmlManager.getStats().getTotalRecords() );
    is.close();

    loadcanon = loadcanon2;
    xmlFile = TestUtil.findFile( fileprefix+"load02.xml" );
    is = new FileInputStream( xmlFile );
    tm = xmlManager.loadTableModel( is );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );
    assertEquals( 3, xmlManager.getStats().getTotalRecords() );
    is.close();

    loadcanon = loadcanon3;
    xmlFile = TestUtil.findFile( fileprefix+"load03.xml" );
    is = new FileInputStream( xmlFile );
    tm = xmlManager.loadTableModel( is );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );
    assertEquals( 4, xmlManager.getStats().getTotalRecords() );
    is.close();


    // inputsource
    loadcanon  = loadcanon1;
    xmlFile = TestUtil.findFile( fileprefix+"load.xml" );
    FileInputStream fis = new FileInputStream( xmlFile );
    InputSource isrc = new InputSource( fis );
    tm = xmlManager.loadTableModel( isrc );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );
    assertEquals( 2, xmlManager.getStats().getTotalRecords() );
    fis.close();

    fis = new FileInputStream( xmlFile );
    isrc = new InputSource( fis );
    tm = xmlManager.loadTableModel( isrc );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );
    assertEquals( 2, xmlManager.getStats().getTotalRecords() );
    fis.close();

    loadcanon = loadcanon2;
    xmlFile = TestUtil.findFile( fileprefix+"load02.xml" );
    fis = new FileInputStream( xmlFile );
    isrc = new InputSource( fis );
    tm = xmlManager.loadTableModel( isrc );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );
    assertEquals( 3, xmlManager.getStats().getTotalRecords() );
    fis.close();

    loadcanon = loadcanon3;
    xmlFile = TestUtil.findFile( fileprefix+"load03.xml" );
    fis = new FileInputStream( xmlFile );
    isrc = new InputSource( fis );
    tm = xmlManager.loadTableModel( isrc );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );
    assertEquals( 4, xmlManager.getStats().getTotalRecords() );
    fis.close();


    // uri
    loadcanon  = loadcanon1;
    xmlFile = TestUtil.findFile( fileprefix+"load.xml" );
    tm = xmlManager.loadTableModelFromURI( TestUtil.makeURI( xmlFile ) );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );
    assertEquals( 2, xmlManager.getStats().getTotalRecords() );

    tm = xmlManager.loadTableModelFromURI( TestUtil.makeURI( xmlFile ) );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );
    assertEquals( 2, xmlManager.getStats().getTotalRecords() );

    loadcanon = loadcanon2;
    xmlFile = TestUtil.findFile( fileprefix+"load02.xml" );
    tm = xmlManager.loadTableModelFromURI( TestUtil.makeURI( xmlFile ) );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );
    assertEquals( 3, xmlManager.getStats().getTotalRecords() );

    loadcanon = loadcanon3;
    xmlFile = TestUtil.findFile( fileprefix+"load03.xml" );
    tm = xmlManager.loadTableModelFromURI( TestUtil.makeURI( xmlFile ) );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );
    assertEquals( 4, xmlManager.getStats().getTotalRecords() );


    // string
    loadcanon  = loadcanon1;
    xmlFile = TestUtil.findFile( fileprefix+"load.xml" );
    tm = xmlManager.loadTableModelFromString( FileUtil.readFile(xmlFile) );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );
    assertEquals( 2, xmlManager.getStats().getTotalRecords() );

    tm = xmlManager.loadTableModelFromString( FileUtil.readFile(xmlFile) );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );
    assertEquals( 2, xmlManager.getStats().getTotalRecords() );

    loadcanon = loadcanon2;
    xmlFile = TestUtil.findFile( fileprefix+"load02.xml" );
    tm = xmlManager.loadTableModelFromString( FileUtil.readFile(xmlFile) );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );
    assertEquals( 3, xmlManager.getStats().getTotalRecords() );

    loadcanon = loadcanon3;
    xmlFile = TestUtil.findFile( fileprefix+"load03.xml" );
    tm = xmlManager.loadTableModelFromString( FileUtil.readFile(xmlFile) );
    assertEquals( loadcanon, canon(tm) );
    assertEquals( loadheads, heads(tm) );
    assertEquals( 4, xmlManager.getStats().getTotalRecords() );
  }



  private String canon( TableModel pTableModel ) throws Exception {
    StringBuffer sb      = new StringBuffer();
    int          numCols = pTableModel.getColumnCount();    
    int          numRows = pTableModel.getRowCount();    
    for( int row = 0; row < numRows; row++ ) {
      for( int col = 0; col < numCols; col++ ) {
        sb.append( pTableModel.getValueAt(row,col) + (col<numCols-1?",":"|") );
      }
    }
    return sb.toString();
  }

  private String heads( TableModel pTableModel ) throws Exception {
    StringBuffer sb      = new StringBuffer();
    int          numCols = pTableModel.getColumnCount();    
    for( int col = 0; col < numCols; col++ ) {
      sb.append( pTableModel.getColumnName(col) + "," );
    }
    return sb.toString();
  }

}