com.mockrunner.jdbc.XMLResultSetFactory Maven / Gradle / Ivy

Go to download
package com.mockrunner.jdbc;

import java.io.File;
import java.io.FileNotFoundException;
import java.util.Iterator;
import java.util.List;

import org.jdom.Document;
import org.jdom.Element;
import org.jdom.input.SAXBuilder;

import com.mockrunner.base.NestedApplicationException;
import com.mockrunner.mock.jdbc.MockResultSet;
import com.mockrunner.util.common.FileUtil;

/**
 * Can be used to create a ResultSet based on
 * a an XML Document of the proper format. You can specify 
 * the dialect, for proper parsing of the document. Furthermore you can 
 * specify the dialect of the ResultSet, which determines 
 * the expected format of the XML Document and whether or not  
 * the column entries should be trimmed (default is true).
 * The file can be specified directly or by its name. The class
 * tries to find the file in the absolut or relative path and
 * (if not found) by calling getResource. Note that the
 * file must exist in the local file system and cannot be loaded from
 * inside a jar archive.
 */
public class XMLResultSetFactory implements ResultSetFactory 
{
    public final static int SYBASE_DIALECT = 0;
    
    private File file = null;
    private String fileName = null;
    private boolean trim = true;
    private int dialect = SYBASE_DIALECT;
    
    public XMLResultSetFactory(String fileName)
    {
        this.file = new File(fileName);
        this.fileName = fileName;
    }
    
    public XMLResultSetFactory(File file)
    {
        this.file = file;
        this.fileName = file.getAbsolutePath();
    }
    
    /**
     * Makes and returns a MockResultSet created from 
     * an existing and valid XML Document.
     * 
     * @return a new MockResultSet
     */
    public MockResultSet create(String id) 
    {
        MockResultSet resultSet;
        
        switch (dialect) 
        {
        	case SYBASE_DIALECT:
        	    resultSet = createSybaseResultSet(id);
        	    break;
        	default:
        	    resultSet = createSybaseResultSet(id);
        	    break;
        }
        
        return resultSet;
    }
    
    /**
     * Get the File being used to read in the 
     * ResultSet. Returns null if
     * the file does not exist.
     * @return the file 
     */
    public File getXMLFile()
    {
        if(file.exists() && file.isFile())
        {
            return file;
        }
        else
        {
            try 
            {
                file = FileUtil.findFile(file.getPath());
                return file;
            } 
            catch(FileNotFoundException exc) 
            {
                throw new RuntimeException("Could not find: " + file.getPath());
            }
        }
    }

    /**
     * Set if the column entries should be trimmed.
     * Default is true.
     * 
     * @param trim
     */
    public void setTrim(boolean trim)
    {
        this.trim = trim;
    }
    
    /**
     * Get whether or not trim is true or false.
     */
    public boolean getTrim() 
    {
        return trim;
    }
    
    /**
     * Set the dialect of the XML Document.  Can be 
     * different for different database systems.  
     * Will determine the expected XML format for 
     * the ResultSet.  SYBASE_DIALECT 
     * is the only accepted dialect for now.
     * @param dialect int specifying which createXXXResultSet 
     * method to call.
     */
    public void setDialect(int dialect) 
    {
        //this.dialect = dialect;
        this.dialect = SYBASE_DIALECT;
    }
    
    /**
     * Get the dialect of the XML DocumentDocument.
     * @return MockResultSet Results read from XML 
     * Document.
     */
    public MockResultSet createSybaseResultSet(String id) 
    {
       MockResultSet resultSet = new MockResultSet(id);
       SAXBuilder builder = new SAXBuilder();
       Document doc = null;
       File fileToParse = getXMLFile();
       if(null == fileToParse)
       {
           throw new RuntimeException("File " + fileName + " not found.");
       }
       try 
       {
           doc = builder.build(fileToParse);
           Element root = doc.getRootElement();
           List rows = root.getChildren("row");
           Iterator ri = rows.iterator();
           boolean firstIteration = true;
           int colNum = 0;
           while (ri.hasNext()) 
           {
               Element cRow = (Element)ri.next();
               List cRowChildren = cRow.getChildren();
               Iterator cri = cRowChildren.iterator();   
               if (firstIteration)
               {
                   List columns = cRowChildren;
                   Iterator ci = columns.iterator();
                   
                   while (ci.hasNext()) 
                   {
                       Element ccRow = (Element)ci.next();
                       resultSet.addColumn(ccRow.getName());
                       colNum++;
                   }
                   firstIteration = false;
               }
               String[] cRowValues = new String[colNum];
               int curCol = 0;
               while (cri.hasNext())
               {
                   Element crValue = (Element)cri.next();
                   String value = trim ? crValue.getTextTrim() : crValue.getText();
                   cRowValues[curCol] = value;
                   curCol++;
               }
               resultSet.addRow(cRowValues);
           }
       } 
       catch(Exception exc) 
       {
           throw new NestedApplicationException("Failure while reading from XML file", exc);
       }
       return resultSet;
    }
}