/***
    * 
    */
   package ar.com.epere4.java2excel.parser;
   
   import java.io.IOException;
   import java.io.InputStream;
   
   import org.xml.sax.SAXException;
  
  import ar.com.epere4.java2excel.parser.impl.BodyDtdImpl;
  
  /***
   * This class allows the construction of several kinds of
   * {@link ar.com.epere4.java2excel.parser.Java2ExcelDtd}.
   * 
   * @author epere4
   * @since 19/02/2006
   */
  public final class Java2ExcelDtdFactory {
      /*** Singleton. */
      public static final Java2ExcelDtdFactory INSTANCE = 
                          new Java2ExcelDtdFactory();
  
      /***
       * @return the only instance of this class.
       * @since 19/02/2006
       */
      public static Java2ExcelDtdFactory getInstance() {
          return INSTANCE;
      }
  
      /***
       * Private constructor for Singleton.
       * 
       * @since 19/02/2006
       */
      private Java2ExcelDtdFactory() {
  
      }
  
      /***
       * This returns a {@link Java2ExcelDtd} implementation that will be
       * configured with the xml received as input. This xml must be valid to the
       * {@link Parser#JAVA2EXCEL_LOCAL_DTD_URL}.
       * 
       * @param xmlInput the xml file.
       * @return a fully configured instance of {@link Java2ExcelDtd}.
       * @throws IOException if an Input/Output exception occurs.
       * @throws SAXException if a parsing exception occurs.
       * @since 19/02/2006
       */
      public Java2ExcelDtd readFromFile(final InputStream xmlInput)
              throws IOException, SAXException {
          Java2ExcelDtd java2ExcelDtd = new Parser().parse(xmlInput);
          return java2ExcelDtd;
      }
      
      /***
       * Similar to calling
       * <code>readFromFile(xmlInput, typesToExcludeInAutoComplete, false)</code>.
       * 
       * @param xmlInput
       *            see {@link #readFromFile(InputStream, Class[], boolean)}
       * @param typesToExcludeInAutoComplete
       *            see {@link #readFromFile(InputStream, Class[], boolean)}
       * @return see {@link #readFromFile(InputStream, Class[], boolean)}
       * @throws IOException
       *             see {@link #readFromFile(InputStream, Class[], boolean)}
       * @throws SAXException
       *             see {@link #readFromFile(InputStream, Class[], boolean)}
       * @since 22/02/2006
       */
      public Java2ExcelDtd readFromFile(final InputStream xmlInput,
              final Class[] typesToExcludeInAutoComplete) throws IOException,
              SAXException {
          return readFromFile(xmlInput, typesToExcludeInAutoComplete, false);
      }
      
      /***
       * 
       * @param xmlInput the xml file.
       * @param typesToExcludeInAutoComplete the array of types to be excluded
       * when searching for getters by reflection. No property that returns an
       * instance of any of the types in this array will be printed in the 
       * excel file.
       * @param ignoreDefaultsExcludes if true, then the values of the
       * typesToExcludeInAutoComplete parameter will overwrite the default ones.
       * @return a fully configured instance of {@link Java2ExcelDtd}.
       * @throws IOException if an Input/Output exception occurs.
       * @throws SAXException if a parsing exception occurs.
       * @since 21/02/2006
       */
      public Java2ExcelDtd readFromFile(final InputStream xmlInput,
              final Class[] typesToExcludeInAutoComplete,
              final boolean ignoreDefaultsExcludes) throws IOException,
              SAXException {
          Java2ExcelDtd java2ExcelDtd = readFromFile(xmlInput);
          
         adjustTypesToExclude((BodyDtdImpl) java2ExcelDtd.getBody(),
                 typesToExcludeInAutoComplete, ignoreDefaultsExcludes);
         
         return java2ExcelDtd;
     }
 
     /***
      * 
      * @return a default implementation of {@link Java2ExcelDtd} with no
      *         properties asociated.
      * @since 21/02/2006
      */
     public Java2ExcelDtd defaultJava2ExcelDtd() {
         InputStream xmlInput = getClass().getResourceAsStream(
                 "emptyJava2Excel.xml");
         Java2ExcelDtd java2ExcelDtd;
         try {
             java2ExcelDtd = new Parser().parse(xmlInput);
         } catch (RuntimeException e) {
             throw e;
         } catch (Exception e) {
             // Nor IOException nor SAXException should occur normally.
             throw new RuntimeException(e);
         }
         return java2ExcelDtd;
     }
     
     /***
      * Default typesToExcludeInAutoComplete are those in
      * {@link BodyDtdImpl#DEFAULT_TYPES_TO_EXCLUDE_IN_AUTO_COMPLETE}.
      * @param includeExtraLevel the number of levels in which to
      * search for properties by reflexion.
      * @return similar to {@link #defaultJava2ExcelDtd()}, but setting
      * the {@link BodyDtd#setIncludeExtraLevel(int)}. 
      * @since 21/02/2006
      */
     public Java2ExcelDtd defaultJava2ExcelDtd(final int includeExtraLevel) {
         Java2ExcelDtd java2ExcelDtd = defaultJava2ExcelDtd();
         ((BodyDtdImpl) java2ExcelDtd.getBody())
                 .setIncludeExtraLevel(includeExtraLevel);
         return java2ExcelDtd;
     }
     
     /***
      * Similar to calling <code>defaultJava2ExcelDtd(includeExtraLevel, 
      * typesToExcludeInAutoComplete, false)</code>.
      * 
      * @param includeExtraLevel
      *            see {@link #defaultJava2ExcelDtd(int, Class[], boolean)}
      * @param typesToExcludeInAutoComplete
      *            see {@link #defaultJava2ExcelDtd(int, Class[], boolean)}
      * @return see {@link #defaultJava2ExcelDtd(int, Class[], boolean)}
      * @see #defaultJava2ExcelDtd(int, Class[], boolean)
      * @since 22/02/2006
      */
     public Java2ExcelDtd defaultJava2ExcelDtd(final int includeExtraLevel,
             final Class[] typesToExcludeInAutoComplete) {
         return defaultJava2ExcelDtd(includeExtraLevel,
                 typesToExcludeInAutoComplete, false);
     }
     
     /***
      * 
      * @param includeExtraLevel the number of levels in which to
      * search for properties by reflexion.
      * @param typesToExcludeInAutoComplete the array of types to be excluded
      * when searching for getters by reflection. No property that returns an
      * instance of any of the types in this array will be printed in the 
      * excel file.
      * @param ignoreDefaultsExcludes if true, then the values of the
      * typesToExcludeInAutoComplete parameter will overwrite the default ones.
      * @return similar to {@link #defaultJava2ExcelDtd(int)}, but setting
      * the types to exclude in auto complete. 
      * @since 21/02/2006
      */
     public Java2ExcelDtd defaultJava2ExcelDtd(final int includeExtraLevel,
             final Class[] typesToExcludeInAutoComplete,
             final boolean ignoreDefaultsExcludes) {
         Java2ExcelDtd java2ExcelDtd = defaultJava2ExcelDtd();
         ((BodyDtdImpl) java2ExcelDtd.getBody())
                 .setIncludeExtraLevel(includeExtraLevel);
 
         
         adjustTypesToExclude((BodyDtdImpl) java2ExcelDtd.getBody(),
                 typesToExcludeInAutoComplete, ignoreDefaultsExcludes);
         
         return java2ExcelDtd;
     }
     
     /***
      * Adds or set the typesToExcludeInAutoComplete to the body, depending
      * on the ignoreDefaultsExcludes parameter.
      * @param body the body where to add or set.
      * @param typesToExcludeInAutoComplete the types to set.
      * @param ignoreDefaultsExcludes if true, then the set is called, if false,
      * then de add is called.
      * @since 22/02/2006
      */
     private void adjustTypesToExclude(final BodyDtdImpl body,
             final Class[] typesToExcludeInAutoComplete,
             final boolean ignoreDefaultsExcludes) {
         if (ignoreDefaultsExcludes) {
             body.setTypesToExcludeInAutoComplete(typesToExcludeInAutoComplete);
         } else {
             body.addTypesToExcludeInAutoComplete(typesToExcludeInAutoComplete);
         }
     }
 }