org.openestate.io.examples.IdxReadingExample Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2015-2016 OpenEstate.org.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.openestate.io.examples;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import org.apache.commons.io.IOUtils;
import org.apache.log4j.PropertyConfigurator;
import org.openestate.io.idx.IdxParser;
import org.openestate.io.idx.IdxRecord;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Example for reading IDX files.
 * 
 * This example illustrates how to read IDX files.
 *
 * @since 1.0
 * @author Andreas Rudolph
 */
public class IdxReadingExample
{
  private final static Logger LOGGER = LoggerFactory.getLogger( IdxReadingExample.class );
  private final static String PACKAGE = "/org/openestate/io/examples";

  /**
   * Start the example application.
   *
   * @param args
   * command line arguments
   */
  public static void main( String[] args )
  {
    // init logging
    PropertyConfigurator.configure(
      IdxReadingExample.class.getResource( PACKAGE + "/log4j.properties" ) );

    // read example file, if no files were specified as command line arguments
    if (args.length<1)
    {
      try
      {
        read( IdxReadingExample.class.getResourceAsStream( PACKAGE + "/idx.csv" ) );
      }
      catch (Exception ex)
      {
        LOGGER.error( "Can't read example file!" );
        LOGGER.error( "> " + ex.getLocalizedMessage(), ex );
        System.exit( 2 );
      }
    }

    // read files, that were specified as command line arguments
    else
    {
      for (String arg : args)
      {
        try
        {
          read( new File( arg ) );
        }
        catch (Exception ex)
        {
          LOGGER.error( "Can't read file '" + arg + "'!" );
          LOGGER.error( "> " + ex.getLocalizedMessage(), ex );
          System.exit( 2 );
        }
      }
    }
  }

  /**
   * Read a {@link File} into an {@link IdxParser} and print some of its
   * content to console.
   *
   * @param csvFile
   * the CSV file to read
   *
   * @throws IOException
   * if the file is not readable
   */
  protected static void read( File csvFile ) throws IOException
  {
    LOGGER.info( "process file: " + csvFile.getAbsolutePath() );
    if (!csvFile.isFile())
    {
      LOGGER.warn( "> The provided file is invalid!" );
      return;
    }
    IdxParser parser = null;
    try
    {
      parser = IdxParser.create( csvFile );
      if (parser==null)
        LOGGER.warn( "> Can't create parser!" );
      else
        printToConsole( parser );
    }
    finally
    {
      IOUtils.closeQuietly( parser );
    }
  }

  /**
   * Read an {@link InputStream} into an {@link IdxParser} and print some of
   * its content to console.
   *
   * @param csvInputStream
   * the input stream to read
   *
   * @throws IOException
   * if the file is not readable
   */
  protected static void read( InputStream csvInputStream ) throws IOException
  {
    LOGGER.info( "process example file" );
    IdxParser parser = null;
    try
    {
      parser = IdxParser.create( csvInputStream );
      if (parser==null)
        LOGGER.warn( "> Can't create parser!" );
      else
        printToConsole( parser );
    }
    finally
    {
      IOUtils.closeQuietly( parser );
    }
  }

  /**
   * Print some content of an {@link IdxParser} to console.
   *
   * @param parser
   * parser instance
   */
  protected static void printToConsole( IdxParser parser )
  {
    // process records
    while (parser.hasNext())
    {
      IdxRecord record = parser.next();

      // get object nr
      String objectNr = record.getRefObject();
      if (objectNr==null) objectNr = "???";

      // get object title
      String objectTitle = record.getObjectTitle();
      if (objectTitle==null) objectTitle = "???";

      // print object informations to console
      System.out.println( "> found object '" + objectNr + "' "
        + "with title '" + objectTitle + "'" );
    }
  }
}