001/*
002 *  Copyright 2016 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.cms.indexing.solr;
017
018import java.util.Collection;
019
020import org.apache.solr.common.SolrInputDocument;
021
022import org.ametys.cms.search.solr.schema.SchemaDefinition;
023import org.ametys.plugins.repository.AmetysObject;
024
025/**
026 * Index additional properties.
027 */
028public interface AdditionalPropertyIndexer
029{
030    
031    /**
032     * Get the object/document types supported by this indexer.
033     * @return The object or document types supported by this indexer.
034     */
035    Collection<String> getSupportedTypes();
036    
037    /**
038     * Index additional object properties in the corresponding document.
039     * @param object The object to index.
040     * @param document The destination document.
041     */
042    void index(AmetysObject object, SolrInputDocument document);
043    
044    /**
045     * Get the schema definitions used by this indexer.
046     * @return The schema definitions used by this indexer.
047     */
048    Collection<SchemaDefinition> getSchemaDefinitions();
049    
050}