/* Copyright 2010 the original author or authors.
 *
 * 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 org.grails.plugins.google.visualization.formatter

import org.apache.commons.lang.StringUtils

/**
 * Standard formatter which acts as formatter super-class
 *
 * @author <a href='mailto:benjamin.muschko@gmail.com'>Benjamin Muschko</a>
 */
abstract class StandardFormatter implements Formatter {
    final column

    StandardFormatter(column) {
        this.column = column
    }

    private appendOptions(optionKeyValues) {
        def options = []

        optionKeyValues.each { key, value ->
            appendOption(options, key, value)
        }

        "{${StringUtils.join(options, ', ')}}"
    }

    private appendOption(options, name, value) {
        if(value != null) {
            options << "${name}: ${renderOptionValue(value)}"
        }
    }

    private renderOptionValue(value) {
        if(value instanceof String) {
            return "'${value}'"
        }

        value
    }

    def getColumns() {
        columns
    }

    @Override
    def getOptions() {
        appendOptions(getFormatterOptions())
    }

    abstract getFormatterOptions() 
}
