Package ome.services.fulltext

Class BridgeHelper

  • All Implemented Interfaces:
    org.hibernate.search.bridge.FieldBridge, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationEventPublisherAware
    Direct Known Subclasses:
    FullTextBridge, ProjectWithImageNameBridge, TablesBridge
    @Deprecated
public abstract class BridgeHelper
extends java.lang.Object
implements org.hibernate.search.bridge.FieldBridge, org.springframework.context.ApplicationEventPublisherAware
    Deprecated.
    Base class for building custom FieldBridge implementations.
    Since:
    3.0-Beta3

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String COMBINED
      Deprecated.
      Name of the Field which contains the union of all fields.
      protected org.slf4j.Logger log
      Deprecated.
       
      protected org.springframework.context.ApplicationEventPublisher publisher
      Deprecated.
       

    • Constructor Summary

      Constructors 
      Constructor Description
      BridgeHelper()
      Deprecated.
       

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      protected void add​(org.apache.lucene.document.Document d, java.lang.String field, java.lang.String value, org.hibernate.search.bridge.LuceneOptions opts)
      Deprecated.
      Helper method which takes the parameters from the set(String, Object, Document, LuceneOptions) method (possibly modified) as well as the parsed String value which should be added to the index, and adds two fields.
      protected void addContents​(org.apache.lucene.document.Document d, java.lang.String name, ome.model.core.OriginalFile file, ome.io.nio.OriginalFilesService files, java.util.Map<java.lang.String,​FileParser> parsers, org.hibernate.search.bridge.LuceneOptions opts)
      Deprecated.
      Second helper method used when parsing files.
      protected void addEnumIfNotNull​(org.apache.lucene.document.Document d, java.lang.String field, ome.model.IEnum value, org.hibernate.search.bridge.LuceneOptions opts)
      Deprecated.
      Helper method which takes the parameters from the set(String, Object, Document, LuceneOptions) method (possibly modified) as well as the IEnum value which should be added to the index, and adds two fields.
      protected void addIfNotNull​(org.apache.lucene.document.Document d, java.lang.String field, java.lang.String value, org.hibernate.search.bridge.LuceneOptions opts)
      Deprecated.
      Helper method which takes the parameters from the set(String, Object, Document, LuceneOptions) method (possibly modified) as well as the parsed String value which should be added to the index, and adds two fields.
      static <T> T getProxiedObject​(T proxy)
      Deprecated.
      Simpler wrapper to handle superclass proxy objects (e.g.
      org.slf4j.Logger logger()
      Deprecated.
       
      protected java.lang.Iterable<java.io.Reader> parse​(ome.model.core.OriginalFile file, ome.io.nio.OriginalFilesService files, java.util.Map<java.lang.String,​FileParser> parsers)
      Deprecated.
      Attempts to parse the given OriginalFile.
      protected <T extends ome.model.IObject>
      void      		 reindex​(T object)
      Deprecated.
      Publishes a ReindexMessage which will get processed asynchronously.
      protected <T extends ome.model.IObject>
      void      		 reindexAll​(java.util.List<T> list)
      Deprecated.
      Publishes a ReindexMessage which will get processed asynchronously.
      abstract void set​(java.lang.String name, java.lang.Object value, org.apache.lucene.document.Document document, org.hibernate.search.bridge.LuceneOptions opts)
      Deprecated.
      Method to be implemented by all bridges.
      void setApplicationEventPublisher​(org.springframework.context.ApplicationEventPublisher publisher)
      Deprecated.
       

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • COMBINED

        public static final java.lang.String COMBINED
        Deprecated.
        Name of the Field which contains the union of all fields. This is also the default search field, so users need not append the value to search the full index. A field name need only be added to a search to eliminate other fields.
        See Also:
        Constant Field Values

      • log

        protected final org.slf4j.Logger log
        Deprecated.

      • publisher

        protected org.springframework.context.ApplicationEventPublisher publisher
        Deprecated.

    • Constructor Detail

      • BridgeHelper

        public BridgeHelper()
        Deprecated.

    • Method Detail

      • getProxiedObject

        public static <T> T getProxiedObject​(T proxy)
        Deprecated.
        Simpler wrapper to handle superclass proxy objects (e.g. Annotation) which do * not behave properly with instanceof checks.
        See Also:
        ticket:5076

      • logger

        public final org.slf4j.Logger logger()
        Deprecated.

      • setApplicationEventPublisher

        public void setApplicationEventPublisher​(org.springframework.context.ApplicationEventPublisher publisher)
        Deprecated.
        Specified by:
        setApplicationEventPublisher in interface org.springframework.context.ApplicationEventPublisherAware

      • set

        public abstract void set​(java.lang.String name,
                         java.lang.Object value,
                         org.apache.lucene.document.Document document,
                         org.hibernate.search.bridge.LuceneOptions opts)
        Deprecated.
        Method to be implemented by all bridges. The "value" argument is an active Hibernate object, and so the full graph can be walked.
        Specified by:
        set in interface org.hibernate.search.bridge.FieldBridge

      • addIfNotNull

        protected void addIfNotNull​(org.apache.lucene.document.Document d,
                            java.lang.String field,
                            java.lang.String value,
                            org.hibernate.search.bridge.LuceneOptions opts)
        Deprecated.
        Helper method which takes the parameters from the set(String, Object, Document, LuceneOptions) method (possibly modified) as well as the parsed String value which should be added to the index, and adds two fields. One with the given field name and another to the COMBINED field which is the default search provided to users. In addition to storing the value as is, another Field will be added for both the named and COMBINED cases using a StringReader to allow Lucene to tokenize the String.
        Parameters:
        d - Document as passed to the set method. Do not modify.
        field - Field name which probably should be modified. If this value is null, then the "value" will only be added to the COMBINED field.
        value - Value which has been parsed out for this field. If null, then this is a no-op.
        opts - LuceneOptions, passed in from the runtime. If overriding on the interface values is required, see SimpleLuceneOptions

      • addEnumIfNotNull

        protected void addEnumIfNotNull​(org.apache.lucene.document.Document d,
                                java.lang.String field,
                                ome.model.IEnum value,
                                org.hibernate.search.bridge.LuceneOptions opts)
        Deprecated.
        Helper method which takes the parameters from the set(String, Object, Document, LuceneOptions) method (possibly modified) as well as the IEnum value which should be added to the index, and adds two fields. One with the given field name and another to the COMBINED field which is the default search provided to users. In addition to storing the value as is, another Field will be added for both the named and COMBINED cases using a StringReader to allow Lucene to tokenize the String.
        Parameters:
        d - Document as passed to the set method. Do not modify.
        field - Field name which probably should be modified. If this value is null, then the "value" will only be added to the COMBINED field.
        value - IEnum whose IEnum.getValue() method will be called. If null, then this is a no-op.
        opts - LuceneOptions, passed in from the runtime. If overriding on the interface values is required, see SimpleLuceneOptions

      • add

        protected void add​(org.apache.lucene.document.Document d,
                   java.lang.String field,
                   java.lang.String value,
                   org.hibernate.search.bridge.LuceneOptions opts)
        Deprecated.
        Helper method which takes the parameters from the set(String, Object, Document, LuceneOptions) method (possibly modified) as well as the parsed String value which should be added to the index, and adds two fields. One with the given field name and another to the COMBINED field which is the default search provided to users. In addition to storing the value as is, another Field will be added for both the named and COMBINED cases using a StringReader to allow Lucene to tokenize the String.
        Parameters:
        d - Document as passed to the set method. Do not modify.
        field - Field name which probably should be modified. If this value is null, then the "value" will only be added to the COMBINED field.
        value - Value which has been parsed out for this field. Should not be null. If you need to store a null value in the index, use a null token like "null".
        opts - LuceneOptions, passed in from the runtime. If overriding on the interface values is required, see SimpleLuceneOptions

      • addContents

        protected void addContents​(org.apache.lucene.document.Document d,
                           java.lang.String name,
                           ome.model.core.OriginalFile file,
                           ome.io.nio.OriginalFilesService files,
                           java.util.Map<java.lang.String,​FileParser> parsers,
                           org.hibernate.search.bridge.LuceneOptions opts)
        Deprecated.
        Second helper method used when parsing files. The OriginalFile will be passed to parse(OriginalFile, OriginalFilesService, Map) to generate Reader instances, which will be read until they signal an end, however it is not the responsibility of this instance to close the Readers since this happens asynchronously. The contents of the file will be parsed both to COMBINED and "file.contents".
        Parameters:
        d - Document as passed to set. Do not modify.
        name - String to be used as the name of the field. If null, then the contents will only be added to the COMBINED Field.
        file - Non-null, possibly unloaded OriginalFile which is used to look up the file on disk.
        files - OriginalFilesService which knows how to find where this OriginalFile is stored on disk.
        parsers - Map of FileParser instances to be used based on the Format of the OriginalFile
        opts - The search option.

      • reindex

        protected <T extends ome.model.IObject> void reindex​(T object)
        Deprecated.
        Publishes a ReindexMessage which will get processed asynchronously.

      • reindexAll

        protected <T extends ome.model.IObject> void reindexAll​(java.util.List<T> list)
        Deprecated.
        Publishes a ReindexMessage which will get processed asynchronously.

      • parse

        protected java.lang.Iterable<java.io.Reader> parse​(ome.model.core.OriginalFile file,
                                                   ome.io.nio.OriginalFilesService files,
                                                   java.util.Map<java.lang.String,​FileParser> parsers)
        Deprecated.
        Attempts to parse the given OriginalFile. If any of the necessary components is null, then it will return an empty, but not null Iterable. Also looks for the catch all parser under "*"
        Parameters:
        file - Can be null.
        Returns:
        will not be null.