com.stratio.cassandra.lucene.schema.mapping.builder.SingleColumnMapperBuilder 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.SingleColumnMapper;
import org.codehaus.jackson.annotate.JsonProperty;

/**
 * Abstract {@link MapperBuilder} for creating new {@link SingleColumnMapper}s.
 *
 * @param  The {@link SingleColumnMapper} to be built.
 * @param  The specific {@link SingleColumnMapper}.
 * @author Andres de la Pena {@literal }
 */
public abstract class SingleColumnMapperBuilder, K extends SingleColumnMapperBuilder>
        extends MapperBuilder {

    /** If the field must be indexed. */
    @JsonProperty("indexed")
    protected Boolean indexed;

    /** If the field must be sorted. */
    @JsonProperty("sorted")
    protected Boolean sorted;

    /** The name of the column to be mapped. */
    @JsonProperty("column")
    protected String column;

    /**
     * Sets if the field supports searching.
     *
     * @param indexed if the field supports searching
     * @return this
     */
    @SuppressWarnings("unchecked")
    public final K indexed(Boolean indexed) {
        this.indexed = indexed;
        return (K) this;
    }

    /**
     * Sets if the field supports sorting.
     *
     * @param sorted if the field supports sorting
     * @return this
     */
    @SuppressWarnings("unchecked")
    public final K sorted(Boolean sorted) {
        this.sorted = sorted;
        return (K) this;
    }

    /**
     * Sets the name of the Cassandra column to be mapped.
     *
     * @param column the name of the Cassandra column to be mapped
     * @return this
     */
    @SuppressWarnings("unchecked")
    public final K column(String column) {
        this.column = column;
        return (K) this;
    }
}