001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
013     */
014    
015    package com.liferay.portlet.dynamicdatamapping.util;
016    
017    import com.liferay.portal.kernel.search.Document;
018    import com.liferay.portlet.dynamicdatamapping.model.DDMStructure;
019    import com.liferay.portlet.dynamicdatamapping.storage.Fields;
020    
021    import java.util.Locale;
022    
023    /**
024     * @author Alexander Chow
025     */
026    public interface DDMIndexer {
027    
028            public static final String DDM_FIELD_NAMESPACE = "ddm";
029    
030            public void addAttributes(
031                    Document document, DDMStructure ddmStructure, Fields fields);
032    
033            public String encodeName(long ddmStructureId, String fieldName);
034    
035            public String encodeName(
036                    long ddmStructureId, String fieldName, Locale locale);
037    
038            public String extractIndexableAttributes(
039                    DDMStructure ddmStructure, Fields fields, Locale locale);
040    
041    }