com.quinsoft.zeidon.AbstractOptionsConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of zeidon-joe Show documentation
There is a newer version: 2.2.0
/**
    This file is part of the Zeidon Java Object Engine (Zeidon JOE).

    Zeidon JOE is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    Zeidon JOE is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with Zeidon JOE.  If not, see .

    Copyright 2009-2015 QuinSoft
 */
package com.quinsoft.zeidon;

import java.util.HashMap;
import java.util.Map;

import com.quinsoft.zeidon.dbhandler.DbHandler;

/**
 * Common code for getting activate/commit configuration values from task config.
 */
public abstract class AbstractOptionsConfiguration
{
    public static final String OI_SOURCE_URL = "oiSourceUrl";

    private final Task                  task;
    private final Map    overrideMap;

    /**
     * If not null then the activator/committer will use this DbHandler for processing.
     */
    private DbHandler dbHandler;

    /**
     * If true then the activate will share a single transaction.
     * Activates will keep the transaction open, a commit will close it.
     */
    private boolean singleTransaction = false;

    public AbstractOptionsConfiguration( Task task )
    {
        this.task = task;
        overrideMap = new HashMap();
    }

    public abstract Application getApplication();

    public String getOiSourceUrl()
    {
        return getConfigValue( getApplication().getName(), OI_SOURCE_URL );
    }

    public void setOiSourceUrl( String url )
    {
        overrideConfigValue( OI_SOURCE_URL, url );
    }

    /**
     * Returns a description of the source of the configuration.
     * E.g "/tmp/zeidon.ini"
     *
     * @return
     */
    public String getConfigSource()
    {
       return task.getObjectEngine().getZeidonPreferences( getApplication() ).getSourceDescription();
    }

    public AbstractOptionsConfiguration overrideConfigValue( String key, String value )
    {
        overrideMap.put( key, value );
        return this;
    }

    public String getConfigValue( String group, String key )
    {
        if ( overrideMap.containsKey( key ) )
            return overrideMap.get( key );

        return task.readZeidonConfig( group, key );
    }

    public String getConfigValue( String group, String key, String defaultValue )
    {
        if ( overrideMap.containsKey( key ) )
            return overrideMap.get( key );

        return task.readZeidonConfig( group, key, defaultValue );
    }

    public Task getTask()
    {
        return task;
    }

    public DbHandler getDbHandler()
    {
        return dbHandler;
    }

    public void setDbHandler( DbHandler dbHandler )
    {
        this.dbHandler = dbHandler;
    }

    public boolean isSingleTransaction()
    {
        return singleTransaction;
    }

    public void setSingleTransaction( boolean singleTransaction )
    {
        this.singleTransaction = singleTransaction;
    }
}