org.greencheek.related.indexing.RelatedItemStorageLocationMapper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of related-indexing Show documentation

There is a newer version: 1.1.0

/*
 *
 *  * Licensed to Relateit under one or more contributor
 *  * license agreements. See the NOTICE file distributed with
 *  * this work for additional information regarding copyright
 *  * ownership. Relateit licenses this file to you 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.greencheek.related.indexing;

import org.greencheek.related.api.indexing.RelatedItem;

/**
 * Basically maps a product to a location (index name) it should be stored in.
 * The implementation must be thread safe.
 */

public interface RelatedItemStorageLocationMapper {
    /**
     * This must be thread safe.  Given a product, returns the location (i.e. index name)
     * that the product will be stored in.
     *
     * @param product
     * @return String representing the index the product is stored in
     */
    public String getLocationName(RelatedItem product);
}