001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
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    }