org.jooq.JSONFormat Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hello-world-plugin Show documentation
Kill Bill Hello World plugin
The newest version!
/*
 * Copyright (c) 2009-2016, Data Geekery GmbH (http://www.datageekery.com)
 * All rights reserved.
 *
 * 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.
 *
 * Other licenses:
 * -----------------------------------------------------------------------------
 * Commercial licenses for this work are available. These replace the above
 * ASL 2.0 and offer limited warranties, support, maintenance, and commercial
 * database integrations.
 *
 * For more information, please visit: http://www.jooq.org/licenses
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 */
package org.jooq;

/**
 * A JSON formatting type, which can be used to configure JSON imports /
 * exports.
 * 
 * The default format is the following, using {@link #header()} equal to
 * true and applying {@link RecordFormat#ARRAY}: 
 * {"fields":[{"name":"field-1","type":"type-1"},
 *            {"name":"field-2","type":"type-2"},
 *             ...,
 *            {"name":"field-n","type":"type-n"}],
 * "records":[[value-1-1,value-1-2,...,value-1-n],
 *            [value-2-1,value-2-2,...,value-2-n]]}
 * 
 * If {@link #header()} is set to false, then the result is simply
 * the records array, either using {@link RecordFormat#ARRAY}: 
 * [[value-1-1,value-1-2,...,value-1-n],
 *  [value-2-1,value-2-2,...,value-2-n]]
 * 
 * or, using {@link RecordFormat#OBJECT}: 
 * [{"field-1": value-1-1, "field-2": value-1-2,..., "field-n": value-1-n},
 *  {"field-1": value-2-1, "field-2": value-2-2,..., "field-n": value-2-n}]
 *
 * @author Lukas Eder
 */
public final class JSONFormat {

    final boolean      header;
    final RecordFormat recordFormat;

    public JSONFormat() {
        this(
            true,
            RecordFormat.ARRAY
        );
    }

    private JSONFormat(
        boolean header,
        RecordFormat recordFormat) {
        this.header = header;
        this.recordFormat = recordFormat;
    }

    /**
     * Whether to emit a header row with column names, defaulting to
     * true.
     */
    public JSONFormat header(boolean newHeader) {
        return new JSONFormat(
            newHeader,
            recordFormat);
    }

    /**
     * Whether to emit a header row with column names, defaulting to
     * true.
     */
    public boolean header() {
        return header;
    }

    /**
     * The record format to be applied, defaulting to
     * {@link RecordFormat#ARRAY}.
     */
    public JSONFormat recordFormat(RecordFormat newRecordFormat) {
        return new JSONFormat(
            header,
            newRecordFormat);
    }

    /**
     * The record format to be applied, defaulting to
     * {@link RecordFormat#ARRAY}.
     */
    public RecordFormat recordFormat() {
        return recordFormat;
    }

    /**
     * The format of individual JSON records.
     */
    public enum RecordFormat {

        /**
         * A record is a JSON array.
         * 
         * This format allows for accessing columns by index, saving space by
         * avoiding repetitive column names in large result sets. Use this
         * preferrably with {@link JSONFormat#header()} equal to
         * true.
         */
        ARRAY,

        /**
         * A record is a JSON object.
         * 
         * This format allows for accessing columns by name, repeating column
         * names in each record.
         */
        OBJECT,
    }
}