com.stratio.cassandra.lucene.schema.mapping.builder.BitemporalMapperBuilder Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2014 Stratio (http://stratio.com)
 *
 * 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 com.stratio.cassandra.lucene.schema.mapping.builder;

import com.stratio.cassandra.lucene.schema.mapping.BitemporalMapper;
import org.codehaus.jackson.annotate.JsonCreator;
import org.codehaus.jackson.annotate.JsonProperty;

/**
 * {@link MapperBuilder} to build a new {@link BitemporalMapperBuilder}.
 *
 * @author Eduardo Alonso {@literal }
 */
public class BitemporalMapperBuilder extends MapperBuilder {

    /** The name of the column containing the valid time start. **/
    @JsonProperty("vt_from")
    private final String vtFrom;

    /** The name of the column containing the valid time stop. **/
    @JsonProperty("vt_to")
    private final String vtTo;

    /** The name of the column containing the transaction time start. **/
    @JsonProperty("tt_from")
    private final String ttFrom;

    /** The name of the column containing the transaction time stop. **/
    @JsonProperty("tt_to")
    private final String ttTo;

    /** The date pattern. **/
    @JsonProperty("pattern")
    private String pattern;

    /** The NOW Value. **/
    @JsonProperty("now_value")
    private Object nowValue;

    /**
     * Returns a new {@link BitemporalMapperBuilder}.
     *
     * @param vtFrom the column name containing the valid time start
     * @param vtTo the column name containing the valid time stop
     * @param ttFrom the column name containing the transaction time start
     * @param ttTo the column name containing the transaction time stop
     */
    @JsonCreator
    public BitemporalMapperBuilder(@JsonProperty("vt_from") String vtFrom,
                                   @JsonProperty("vt_to") String vtTo,
                                   @JsonProperty("tt_from") String ttFrom,
                                   @JsonProperty("tt_to") String ttTo) {
        this.vtFrom = vtFrom;
        this.vtTo = vtTo;
        this.ttFrom = ttFrom;
        this.ttTo = ttTo;
    }

    /**
     * Sets the date format pattern to be used.
     *
     * @param pattern the date format pattern to be used
     * @return this
     */
    public BitemporalMapperBuilder pattern(String pattern) {
        this.pattern = pattern;
        return this;
    }

    /**
     * Sets the now value to be used.
     *
     * @param nowValue the now value to be used
     * @return this
     */
    public BitemporalMapperBuilder nowValue(Object nowValue) {
        this.nowValue = nowValue;
        return this;
    }

    /**
     * Returns the {@link BitemporalMapper} represented by this {@link MapperBuilder}.
     *
     * @param field the name of the field to be built
     * @return the {@link BitemporalMapper} represented by this
     */
    @Override
    public BitemporalMapper build(String field) {
        return new BitemporalMapper(field, validated, vtFrom, vtTo, ttFrom, ttTo, pattern, nowValue);
    }
}