org.jpac.configuration.Property Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of elbfisch.core Show documentation
Open-source runtime system for component-based implementation of automation solutions with Java
The newest version!
/**
 * PROJECT   : Elbfisch - java process automation controller (jPac)
 * MODULE    : Property.java
 * VERSION   : -
 * DATE      : -
 * PURPOSE   : 
 * AUTHOR    : Bernd Schuster, MSK Gesellschaft fuer Automatisierung mbH, Schenefeld
 * REMARKS   : -
 * CHANGES   : CH#n   
 *
 * This file is part of the jPac process automation controller.
 * jPac is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * jPac 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with the jPac If not, see .
 */

package org.jpac.configuration;

import org.apache.commons.configuration.ConfigurationException;
import org.jpac.AbstractModule;

/**
 * base class of all elbfisch property classes
 * @author berndschuster
 */
public abstract class Property {
    String  key;
    boolean classProperty;
    boolean touched;
    
    public Property(Object owningObject, String key, Object defaultValue, String comment, boolean classProperty) throws ConfigurationException{
        this.classProperty = classProperty;
        Configuration configuration = Configuration.getInstance();
        //compute key
        if (classProperty){
            //if it is a class property, prefix its key with the canonical name of the class
            this.key = owningObject.getClass().getCanonicalName().replace(".", "..").concat(".").concat(key);
        }
        else if (owningObject instanceof AbstractModule){
            //if it is a module, prefix its key with the qualified name of the module
            this.key = ((AbstractModule)owningObject).getQualifiedName().concat(".").concat(key);
        }
        else{
            //otherwise, take the given key itself
            this.key = key;
        }
        //add property, if not already part of the configuration
        if (!configuration.containsKey(this.key)){
            configuration.addProperty(this.key, defaultValue == null ? "" : defaultValue);
        }
        if (comment != null){
            String commentKey = this.key + "[@comment]";
            if (!configuration.containsKey(commentKey)){
                //add it to the property
                configuration.addProperty(commentKey, comment);
            }
            //mark this comment as been touched during actual session
            configuration.getTouchedProperties().add(commentKey);
        }
        //mark this property as been touched during actual session
        configuration.getTouchedProperties().add(this.key);
    }
    
    public Property(String key) throws ConfigurationException{
        Configuration configuration = Configuration.getInstance();
        this.key = key;
        // check if the property exists inside configuration
        if (!configuration.containsKey(this.key)){
            //if not found, check if is a class property
            int lastPunktIndex = this.key.lastIndexOf(".");
            this.key = this.key.substring(0, lastPunktIndex).replace(".", "..") + this.key.substring(lastPunktIndex);
            if (!configuration.containsKey(this.key)){
                throw new ConfigurationException("property " + key + " does not exist!");
            }
            else {
                this.classProperty = true;
            }
        }
    }
    
    private void assertKey(String key) throws ConfigurationException{
        if (key.contains(".")){
            throw new ConfigurationException("a period ('.') is not allowed as part of the key");
        }
    }
        
    public String getKey(){
        return key;
    }

    public boolean isClassProperty(){
        return classProperty;
    }
    
    public boolean isTouched(){
        return touched;
    }
    
    @Override
    public String toString(){
        String str = super.toString();
        try{
            str = this.getClass().getSimpleName() + "(" + Configuration.getInstance().getProperty(key) + ")";
        }
        catch(ConfigurationException exc){
            //return super.toString()
        }
        return str;
    }
}