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.portal.kernel.util.StringPool;
019    import com.liferay.portlet.dynamicdatamapping.model.DDMStructure;
020    import com.liferay.portlet.dynamicdatamapping.storage.Fields;
021    
022    import java.util.Locale;
023    
024    /**
025     * @author Alexander Chow
026     */
027    public interface DDMIndexer {
028    
029            public static final String DDM_FIELD_NAMESPACE = "ddm";
030    
031            public static final String DDM_FIELD_PREFIX =
032                    DDMIndexer.DDM_FIELD_NAMESPACE + DDMIndexer.DDM_FIELD_SEPARATOR;
033    
034            public static final String DDM_FIELD_SEPARATOR = StringPool.FORWARD_SLASH;
035    
036            public void addAttributes(
037                    Document document, DDMStructure ddmStructure, Fields fields);
038    
039            public String encodeName(long ddmStructureId, String fieldName);
040    
041            public String encodeName(
042                    long ddmStructureId, String fieldName, Locale locale);
043    
044            public String extractIndexableAttributes(
045                    DDMStructure ddmStructure, Fields fields, Locale locale);
046    
047    }