de.micromata.genome.gwiki.page.impl.GWikiPropsDescriptorValue.java Source code

Introduction

Here is the source code for de.micromata.genome.gwiki.page.impl.GWikiPropsDescriptorValue.java

Source

//
// Copyright (C) 2010-2016 Roger Rene Kommer & Micromata GmbH
//
// Licensed 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.
//

package de.micromata.genome.gwiki.page.impl;

import java.io.Serializable;
import java.io.StringWriter;
import java.util.Map;

import org.apache.commons.lang3.StringUtils;

import de.micromata.genome.gwiki.model.GWikiProps;

/**
 * Descriptor of a property value (Settings.properties or other).
 * 
 * @author Roger Rene Kommer (r.kommer@micromata.de)
 * 
 */
public class GWikiPropsDescriptorValue implements Serializable {

    /**
     * The Constant serialVersionUID.
     */
    private static final long serialVersionUID = 5787594707201861142L;

    /**
     * The key.
     */
    private String key;

    /**
     * Label for display in editor. if not set uses key instead.
     */
    private String label;

    /**
     * The description.
     */
    private String description;

    /**
     * Local link to help page.
     */
    private String helpLink;

    /**
     * The type.
     */
    /*
     * <ul> <li>STRING: No restriction</li>
     * 
     * <li>PAGEID</li>
     * 
     * <li>PAGEIDLIST</li>
     * 
     * <li>CLASSNAME</li>
     * 
     * <li>BOOLEAN</li>
     * 
     * <li>RIGHT</li>
     * 
     * <li>STRINGLIST: Comma seperated list</li>
     * 
     * <li>STRINGMAP: Pipe list</li>
     * 
     * <li>TIMESTAMP</li>
     * 
     * <li>OPTION</li>
     * 
     * <li>LABEL</li>
     */
    private String type = "STRING";

    /**
     * The read only.
     */
    private boolean readOnly = false;

    /**
     * The requires value.
     */
    private boolean requiresValue = false;

    /**
     * The required view right.
     */
    private String requiredViewRight;

    /**
     * The required edit right.
     */
    private String requiredEditRight;

    /**
     * Wird nur dargestellt, wenn das Template verwendet wird.
     */
    private String requiredMetaTemplateId;

    /**
     * Default Value wird automatisch gesetzt.
     * 
     * if string value starts with "def getDefaultValue(" it will be evaluted a groovy method with signature:
     * 
     * String getDefaultValue(GWikiContext wikiContext, GWikiPropsDescriptorValue wikiPropDescriptor, String name);
     */
    private String defaultValue;

    /**
     * either a Map with key/values. key-&gt; is internal name, value is used to display.
     * 
     * or a groovy function with following signature: Map getOptionCollection(GWikiContext wikiContext,
     * GWikiPropsDescriptorValue wikiPropDescriptor, String name, String value);
     */
    private Map<String, String> optionValues;

    /**
     * The controler script.
     */
    private String controlerScript;

    /**
     * The group.
     */
    private String group;

    /**
     * Parses the request.
     *
     * @param pct the pct
     */
    public void parseRequest(PropsEditContext pct) {
        if (pct.invokeOnControlerBean("onParseRequest") == true) {
            return;
        }
        if (pct.isReadOnly() == true || pct.isDisplayable() == false) {
            return;
        }
        String value = pct.getRequestValue();
        /*
         * if (StringUtils.isEmpty(value) == true) { value = pct.getDefaultValue(); }
         */
        if (StringUtils.equals(pct.getControlType(), "DATE") == true) {
            value = GWikiProps.formatTimeStamp(pct.getWikiContext().parseUserDateString(value));
        }
        pct.setPropsValue(value);
    }

    /**
     * Validate.
     *
     * @param pct the pct
     */
    public void validate(PropsEditContext pct) {
        if (pct.invokeOnControlerBean("onValidate") == true) {
            return;
        }
        if (pct.isReadOnly() == true || pct.isDisplayable() == false) {
            return;
        }
        String reqValue = pct.getPropsValue();
        if (pct.getPropDescriptor().isRequiresValue() == true) {
            if (StringUtils.isBlank(reqValue) == true) {
                pct.getWikiContext().addValidationError("gwiki.edit.EditPage.message.propmusthavevalue",
                        pct.getPropName());
            }
        }
    }

    /**
     * Render.
     *
     * @param editor the editor
     * @param pct the pct
     * @return the string
     */
    public String render(GWikiPropsEditorArtefakt<?> editor, PropsEditContext pct) {
        StringWriter sout = new StringWriter();
        pct.getWikiContext().getCreatePageContext().pushBody(sout);
        if (pct.invokeOnControlerBean("onRender") == false) {
            editor.onRenderInternal(pct);
        }
        pct.getWikiContext().getCreatePageContext().popBody();
        return sout.getBuffer().toString();
    }

    public String getKey() {
        return key;
    }

    public void setKey(String key) {
        this.key = key;
    }

    public boolean isReadOnly() {
        return readOnly;
    }

    public void setReadOnly(boolean readOnly) {
        this.readOnly = readOnly;
    }

    public boolean isRequiresValue() {
        return requiresValue;
    }

    public void setRequiresValue(boolean requiresValue) {
        this.requiresValue = requiresValue;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }

    public String getType() {
        return type;
    }

    public void setType(String type) {
        this.type = type;
    }

    public String getRequiredViewRight() {
        return requiredViewRight;
    }

    public void setRequiredViewRight(String requiredViewRight) {
        this.requiredViewRight = requiredViewRight;
    }

    public String getRequiredEditRight() {
        return requiredEditRight;
    }

    public void setRequiredEditRight(String requiredEditRight) {
        this.requiredEditRight = requiredEditRight;
    }

    public String getRequiredMetaTemplateId() {
        return requiredMetaTemplateId;
    }

    public void setRequiredMetaTemplateId(String requiredMetaTemplateId) {
        this.requiredMetaTemplateId = requiredMetaTemplateId;
    }

    public String getDefaultValue() {
        return defaultValue;
    }

    public void setDefaultValue(String defaultValue) {
        this.defaultValue = defaultValue;
    }

    public String getControlerScript() {
        return controlerScript;
    }

    public void setControlerScript(String controlerScript) {
        this.controlerScript = controlerScript;
    }

    public Map<String, String> getOptionValues() {
        return optionValues;
    }

    public void setOptionValues(Map<String, String> optionValues) {
        this.optionValues = optionValues;
    }

    public String getLabel() {
        return label;
    }

    public void setLabel(String label) {
        this.label = label;
    }

    public String getHelpLink() {
        return helpLink;
    }

    public void setHelpLink(String helpLink) {
        this.helpLink = helpLink;
    }

    public String getGroup() {
        return group;
    }

    public void setGroup(String group) {
        this.group = group;
    }

}