org.n52.youngs.transform.MappingEntry Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of main Show documentation
A mapping platform to load CSW records into Elasticsearch
The newest version!
/*
 * Copyright 2015-2019 52°North Initiative for Geospatial Open Source
 * Software GmbH
 *
 * 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.n52.youngs.transform;

import java.util.Collections;
import java.util.List;
import java.util.Map;
import javax.xml.xpath.XPathExpression;

/**
 *
 * @author Daniel Nüst
 */
public interface MappingEntry {

    public interface IndexProperties {

        public static final String TYPE = "type";

    }

    public static final String INDEX_MAPPING_ATTRIBUTE = "index";

    public XPathExpression getXPath();

    public String getFieldName();

    public Map getIndexProperties();

    public Object getIndexPropery(String name);

    public boolean isIdentifier();

    public boolean isLocation();

    public boolean hasCoordinates();

    /**
     *
     * @return a list of expressions to be evaluated on the element found by getXPath() to create coordinates
     */
    public List getCoordinatesXPaths();

    public boolean hasCoordinatesType();

    public String getCoordinatesType();

    public boolean isRawXml();

    public boolean hasReplacements();

    public Map getReplacements();

    public boolean hasSplit();

    public String getSplit();

    public boolean hasOutputProperties();

    public Map getOutputProperties();

    /**
     *
     * @return true if the field is stored "analyzed" (default, often set to "not_analyzed" though),
     *              which has implications for queries (lowercasing part of default analyzer). Returns also
     *              false when the field is not indexed at all.
     */
    public boolean isAnalyzed();

    XPathExpression getCondition();

    boolean hasCondition();

    default List getChildren() {
        return Collections.emptyList();
    };

    default boolean hasSuggest() {
        return false;
    }

    default Map getSuggest() {
        return Collections.emptyMap();
    }

}