package com.sourceforge.jpatterns.core.configuration;

 import com.sourceforge.jpatterns.core.configuration.model.JPatternsConfigsBean;

 import java.io.File;

 import java.util.List;

 /**

  * This interface is a single entry point for the castor based configuration would be used to provide the framework with the working

  * data. This interface would be used for the both purposes:

  * <ul>

  * <li>First one is to obtain the system configuration which would be used for the making the framework configured itself - the

  * idea of this self configuration is as follows. First of all the initial stuff to be configured is obtained using the properties

  * file, but then when the "factory" pattern would implemented (meaning at the appropriate layer of JPatterns, cause we can not

  * use it here for example), we would be able to use JPatterns mechanisms itself to allow configuring the system effectively</li>

  * <li>The second case is when JPatterns would be used by the user - then we should provide the way to another stuff of the

  * JPatterns to receive the configuration to be used later</li>

  * </ul>

  * <br/>

  * The implementations of this interface could deal also with the overriden files/folders(where to search for the JPatterns

  * configuration). This overriding could be done via JVM and default properties files. It would allow to the user to override

  * everything though the properties files, through JVM params etc.

  * <br/>

  * Please review the ways use of the framework is able to customize the behaviour of the system:

  * <br/>

  * The instance we need to use is configured at the

  * properties file, so there is a way for the developer to override this implementation by the custom one.

  * todo [zmicer]: pleaes think over how to configure this through the properties files at the PropertiesBasedFactory - currently it is not

  * done in this way

  *

  * $Author:: zmicer             $<br/>

  * $Rev:: 57                    $<br/> * $Date:: 2007-08-23 09:16:37 #$<br/>

  * $Date:: 2007-08-23 09:16:37 #$<br/>

  */

 public interface IJPConfigurator

 {

     /**

      * @return the name of the configuration file is used for the configuration of the working JPatterns itself

      * <br/>

      * Please review the Java Docs of the concrete implementation to obtain the algorithms for getting this name.

      */

     String getJPatternsFrameworkConfigurationFileName();

     /**

      * @return the name of the configuration file is used for the configuration of the working JPatterns itself (custom configuration)

      * Returns the custom configuration.

      */

     String getJPatternsFrameworkCustomConfigurationFileName();

     /**

      * @return the List of String objects representing the configuration file names is provided by the consumers of the JPatterns

      * (simply speaking the configuration of the third party factories, and another patterns, the configuration which is necessary to

      * be parsed by JPatterns to make this framework help other developers - consumers of the framework)

      */

     List<File> getJPatternsConsumerConfigurationFiles();

     /**

      * @return the List of String objects representing the configuration file names is provided by the consumers of the JPatterns

      * (simply speaking the configuration of the third party factories, and another patterns, the configuration which is necessary to

      * be parsed by JPatterns to make this framework help other developers - consumers of the framework).

      * <br/>

      * Returns the custom configuration.

      */

     List<File> getJPatternsConsumerCustomConfigurationFiles();

     /**

      * @return true in the case the default XML framework configuration is presents.

      */

     boolean defaultJPatternsFrameworkConfigurationPresents();

     /**

      * @return true in the case the system custom configuration is presents (the value was provided via the JVM parameter

      * using the

      * <code>com.sourceforge.jpatterns.core.JPConstants.XMLConfigFilesConstants.CUSTOM_XML_FRAMEWORK_CONFIG_FILE_NAME_JVM_PARAM</code>

      * or this file with the name

      * <code>com.sourceforge.jpatterns.core.JPConstants.XMLConfigFilesConstants.CUSTOM_XML_FRAMEWORK_CONFIG_FILE_NAME</code> exists)

      */

     boolean customJPatternsFrameworkConfigurationPresents();

     /**

      * @return true in the case the default XML framework configuration is presents.

      */

     boolean defaultJPatternsConsumerConfigurationPresents();

     /**

      * @return true in the case the system custom configuration is presents (the value was provided via the JVM parameter

      * using the

      * <code>com.sourceforge.jpatterns.core.JPConstants.XMLConfigFilesConstants.CUSTOM_XML_FRAMEWORK_CONFIG_FILE_NAME_JVM_PARAM</code>

      * or this file with the name

      * <code>com.sourceforge.jpatterns.core.JPConstants.XMLConfigFilesConstants.CUSTOM_XML_FRAMEWORK_CONFIG_FILE_NAME</code> exists)

      */

     boolean customJPatternsConsumerConfigurationPresents();

     /**

      * @return the entry point for the system configuration is used for the JPatterns itself.

      * <br/>

      * Please be noticed this configuration is a merged one: the default and custom configuration are used

      */

     JPatternsConfigsBean getJPatternsFrameworkConfiguration();

     /**

      * @return the JPatternsConfig storing all the users configuration.

      * <br/>

      * Please be noticed this configuration is a merged one: the default and custom configuration files are used (there are lots of

      * the configurations files could be at the default pathes and at the custom specific pathes)

      */

     JPatternsConfigsBean getJPatternsConsumerConfiguration();

 }