[hibernate-issues] [Hibernate-JIRA] Commented: (HSEARCH-572) Reconsider deprecating luceneOptions.getStore(), luceneOptions.getIndex() etc

[ http://opensource.atlassian.com/projects/hibernate/browse/HSEARCH-572?pag... ] Emmanuel Bernard commented on HSEARCH-572: ------------------------------------------ I've undeprecated the methods and heavily insisted on not using the methods. This API might change a tiny bit with HSEARCH-434 (NumericField support). {code} /** * A helper class for building Field objects and associating them to Documents. * A wrapper class for Lucene parameters needed for indexing. * * The recommended approach to index is to use {@link #addFieldToDocument(String, String, org.apache.lucene.document.Document)} * as all the options delcared by the user are transparently carried over. Compression is also provided transparently. * * String fieldValue = convertToString(value); * luceneOptions.addFieldToDocument(name, fieldValue, document); * * * @author Emmanuel Bernard * @author Sanne Grinovero * @author Hardy Ferentschik */ public interface LuceneOptions { /** * Add a new field with the name {@code fieldName} to the Lucene Document {@code document} using the value * {@code indexedString}. * If the indexedString is null then the field is not added to the document. * * The field options are following the user declaration: * - stored or not * - compressed or not * - what type of indexing strategy * - what type of term vector strategy * * @param fieldName The field name * @param indexedString The value to index * @param document the document to which to add the the new field */ void addFieldToDocument(String fieldName, String indexedString, Document document); /** * Prefer the use of {@link #addFieldToDocument(String, String, org.apache.lucene.document.Document)} * over manually building your Field objects and adding them to the Document. * * To use compression either use #addFieldToDocument or refer * to Lucene documentation to implement your own compression * strategy. * * @return the compression strategy declared by the user {@code true} if the field value is compressed, {@code false} otherwise. */ boolean isCompressed(); /** * Prefer the use of {@link #addFieldToDocument(String, String, org.apache.lucene.document.Document)} * over manually building your Field objects and adding them to the Document. * * Return the storage strategy declared by the user * {@code org.apache.lucene.document.Field.Store.YES} if the field is stored * {@code org.apache.lucene.document.Field.Store.NO} otherwise. * * To determine if the field must be compressed, use {@link #isCompressed()}. * * Starting from version 3.3, Store.COMPRESS is no longer returned, use {@link #isCompressed()} * * To use compression either use #addFieldToDocument or refer * to Lucene documentation to implement your own compression * strategy. */ Field.Store getStore(); /** * Prefer the use of {@link #addFieldToDocument(String, String, org.apache.lucene.document.Document)} * over manually building your Field objects and adding them to the Document. * * Return the indexing strategy declared by the user */ Field.Index getIndex(); /** * Prefer the use of {@link #addFieldToDocument(String, String, org.apache.lucene.document.Document)} * over manually building your Field objects and adding them to the Document. * * Return the term vector strategy declared by the user */ Field.TermVector getTermVector(); /** * Prefer the use of {@link #addFieldToDocument(String, String, org.apache.lucene.document.Document)} * over manually building your Field objects and adding them to the Document. * * Return the boost factor declared by the user */ Float getBoost(); } {code} -- This message is automatically generated by JIRA. - If you think it was sent incorrectly contact one of the administrators: http://opensource.atlassian.com/projects/hibernate/secure/Administrators.... - For more information on JIRA, see: http://www.atlassian.com/software/jira