com.stratio.cassandra.lucene.schema.mapping.MultipleColumnMapper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cassandra-lucene-index-plugin Show documentation
Cassandra Lucene Index plugin
The newest version!
/*
 * 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;

import com.google.common.base.MoreObjects;
import com.stratio.cassandra.lucene.column.Column;
import com.stratio.cassandra.lucene.column.Columns;
import org.apache.lucene.document.Field;
import org.apache.lucene.index.IndexableField;

import javax.validation.constraints.NotNull;
import java.util.*;

/**
 * Class for mapping between Cassandra's columns and Lucene documents.
 *
 * @param  The base type.
 * @author Andres de la Pena {@literal }
 */
public abstract class MultipleColumnMapper> extends Mapper {

    /**
     * Builds a new {@link SingleColumnMapper} supporting the specified types for indexing and clustering.
     *
     * @param field the name of the field
     * @param validated if the field must be validated
     * @param mappedColumns the names of the columns to be mapped
     * @param supportedTypes the supported column value data types
     */
    public MultipleColumnMapper(String field,
                                Boolean validated,
                                List mappedColumns,
                                List> supportedTypes) {
        super(field,
              false,
              validated,
              null,
              mappedColumns,
              supportedTypes,
              EMPTY_TYPE_LIST,
              false);
    }

    /**
     * Builds a new {@link SingleColumnMapper} supporting the specified types for indexing and clustering.
     *
     * @param field the name of the field
     * @param validated if the field must be validated
     * @param mappedColumns the names of the columns to be mapped
     * @param supportedTypes the supported column value data types
     * @param excludedTypes the explicitly excluded value data types
     */
    public MultipleColumnMapper(String field,
                                Boolean validated,
                                List mappedColumns,
                                List> supportedTypes,
                                List> excludedTypes ) {
        super(field,
              false,
              validated,
              null,
              mappedColumns,
              supportedTypes,
              excludedTypes,
              false);
    }

    /** {@inheritDoc} */
    @Override
    public abstract String toString();

}