package org.apache.torque.generator.configuration.controller;
   
   /*
    * Licensed to the Apache Software Foundation (ASF) under one
    * or more contributor license agreements.  See the NOTICE file
    * distributed with this work for additional information
    * regarding copyright ownership.  The ASF licenses this file
    * to you 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.
   */
  
  import org.apache.torque.generator.control.existingtargetstrategy.ReplaceTargetFileStrategy;
  import org.apache.torque.generator.outlet.Outlet;
  import org.apache.torque.generator.qname.QualifiedName;
  import org.apache.torque.generator.source.SourceProcessConfiguration;
  import org.apache.torque.generator.source.SourceProvider;
  
  /**
   * The configuration for an output (typically one or more files).
   */
  public class Output
  {
      /**
       * The name by which this output can be identified.
       */
      private QualifiedName name;
  
      /**
       * The source provider to access the input for generation.
       */
      private SourceProvider sourceProvider;
  
      /**
       * The information on how to post-process the sources before generation.
       */
      private SourceProcessConfiguration sourceProcessConfiguration;
  
      /**
       * The outlet which generates the content.
       */
      private OutletReference contentOutlet;
  
      /**
       * The outlet which generates the filename, or null if the
       * path to the generated file is explicitly given in <code>path</code>.
       */
      private Outlet filenameOutlet;
  
      /**
       * The filename of the generated file, or null if the filename must
       * still be generated using a filenameOutlet.
       * This attribute is also used to store the generated filename
       * if it was generated using the filenameOutlet.
       */
      private String filename;
  
      /**
       * The strategy how existing target files should be handled.
       */
      private String existingTargetStrategy
              = ReplaceTargetFileStrategy.STRATEGY_NAME;
  
      /**
       * The key for the output directory into which the output is written,
       * or null for the default output directory.
       */
      private String outputDirKey;
  
      /**
       * The character encoding of the generated file, or null for the platform
       * default encoding.
       */
      private String encoding;
  
      /**
       * Constructor.
       *
       * @param name the name by which this output can be identified.
       */
      public Output(QualifiedName name)
      {
          this.name = name;
      }
  
      /**
       * Returns the name by which this output can be identified.
       *
       * @return the name by which this output can be identified, not null.
       */
     public QualifiedName getName()
     {
         return name;
     }
 
     /**
      * Returns the source provider which provides the input for generating the
      * output file's contents.
      *
      * @return the source provider which provides the input for generation.
      */
     public SourceProvider getSourceProvider()
     {
         return sourceProvider;
     }
 
     /**
      * Sets the source provider which provides the input for generating the
      * output file's contents.
      *
      * @param sourceProvider the source provider which provides the input for
      *        generation.
      */
     public void setSourceProvider(SourceProvider sourceProvider)
     {
         this.sourceProvider = sourceProvider;
     }
 
     /**
      * Returns how the sources should be post-processed before generation.
      *
      * @return the information about post-processing the sources.
      */
     public SourceProcessConfiguration getSourceProcessConfiguration()
     {
         return sourceProcessConfiguration;
     }
 
     /**
      * Sets how the sources should be post-processed before generation.
      *
      * @param sourceProcessConfiguration the information about
      *      post-processing the sources.
      */
     public void setSourceProcessConfiguration(
             SourceProcessConfiguration sourceProcessConfiguration)
     {
         this.sourceProcessConfiguration = sourceProcessConfiguration;
     }
 
     /**
      * Sets the name of the file to generate.
      * This is also used to store the generated filename
      * if it was generated using the filenameOutlet.
      *
      * @param filename the name of the file to generate.
      */
     public void setFilename(String filename)
     {
         this.filename = filename;
     }
 
     /**
      * Returns the name of the file to generate. Either this name was
      * given explicitly or it was set using the filenameOutlet.
      *
      * @return the name of the file to generate.
      */
     public String getFilename()
     {
         return filename;
     }
 
     /**
      * Returns the reference to the outlet which should produce the content.
      *
      * @return the reference to the outlet responsible for producing the
      *         content.
      */
     public OutletReference getContentOutlet()
     {
         return contentOutlet;
     }
 
     /**
      * Sets the reference to the outlet which should produce the content.
      *
      * @param contentOutlet the reference to the outlet responsible
      *        for producing the content.
      */
     public void setContentOutlet(OutletReference contentOutlet)
     {
         this.contentOutlet = contentOutlet;
     }
 
     /**
      * Returns the reference to the outlet which should produce
      * the file name. If this attribute is set, it takes precedence over a
      * set filename.
      *
      * @return the reference to the outlet responsible for producing the
      *         file name, or null if the file name is explicitly given.
      */
     public Outlet getFilenameOutlet()
     {
         return filenameOutlet;
     }
 
     /**
      * Sets the reference to the outlet which should produce
      * the file name.
      *
      * @param filenameOutlet the reference to the outlet responsible
      *        for producing the file name.
      */
     public void setFilenameOutlet(Outlet filenameOutlet)
     {
         this.filenameOutlet = filenameOutlet;
     }
 
     /**
      * Returns the strategy how existing target files should be handled.
      *
      * @return the strategy name.
      */
     public String getExistingTargetStrategy()
     {
         return existingTargetStrategy;
     }
 
     /**
      * Sets the strategy how existing target files should be handled.
      *
      * @param existingTargetStrategy the strategy name.
      */
     public void setExistingTargetStrategy(String existingTargetStrategy)
     {
         this.existingTargetStrategy = existingTargetStrategy;
     }
 
     /**
      * Returns the key for the output directory into which the output is
      * written.
      *
      * @return the key  for the output directory, or null for the default
      *         output directory.
      */
     public String getOutputDirKey()
     {
         return outputDirKey;
     }
 
     /**
      * Sets the key for the output directory into which the output is
      * written.
      *
      * @param outputKeyDir the key  for the output directory,
      *        or null for the default output directory.
      */
     public void setOutputDirKey(String outputKeyDir)
     {
         this.outputDirKey = outputKeyDir;
     }
 
     /**
      * Returns the character encoding of the generated file(s).
      *
      * @return The character encoding of the generated file,
      *         or null for the platform default encoding.
      */
     public String getEncoding()
     {
         return encoding;
     }
 
     /**
      * Sets the character encoding of the generated file(s).
      *
      * @param encoding The character encoding of the generated file,
      *        or null for the platform default encoding.
      */
     public void setEncoding(String encoding)
     {
         this.encoding = encoding;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public String toString()
     {
         StringBuffer result = new StringBuffer();
         result.append("(OutputFile: sourceProvider=").append(sourceProvider)
                 .append(",existingTargetStrategy=")
                 .append(existingTargetStrategy)
                 .append(",encoding=")
                 .append(encoding)
                 .append(",filenameOutlet=")
                 .append(filenameOutlet)
                 .append(",contentOutlet=")
                 .append(contentOutlet).append(")");
         return result.toString();
     }
 }