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.search.solr.schema;
017
018import org.apache.solr.client.solrj.request.schema.SchemaRequest;
019
020/**
021 * Interface representing a solr schema definition (field, dynamic field, copyField or field type).
022 */
023public interface SchemaDefinition
024{
025    /**
026     * Get the schema request update.
027     * @return The update request
028     */
029    public SchemaRequest.Update getSchemaUpdate();
030    
031    /**
032     * Test if the definition is already defined
033     * @param schemaFields the existing schema fields
034     * @return <code>true</code> if the definition is in the schema fields
035     */
036    public boolean exists(SchemaFields schemaFields);
037}