Package org.apache.tika.parser.ner.opennlp

Class OpenNLPNameFinder

java.lang.Object
org.apache.tika.parser.ner.opennlp.OpenNLPNameFinder
All Implemented Interfaces:
NERecogniser
public class OpenNLPNameFinder extends Object implements NERecogniser
An implementation of NERecogniser that finds names in text using Open NLP Model. This implementation works with only one entity type. For chain this name finder instances, see OpenNLPNERecogniser

  • Constructor Details

    • OpenNLPNameFinder

      public OpenNLPNameFinder(String nameType, String nerModelPath)
      Creates OpenNLP name finder
      Parameters:
      nameType - the entity type recognised by the given NER model
      nerModelPath - path to ner model

  • Method Details

    • tokenize

      public static String[] tokenize(String text)

    • isAvailable

      public boolean isAvailable()
      Description copied from interface: NERecogniser
      checks if this Named Entity recogniser is available for service
      Specified by:
      isAvailable in interface NERecogniser
      Returns:
      true if this recogniser is ready to recognise, false otherwise

    • getEntityTypes

      public Set<String> getEntityTypes()
      Description copied from interface: NERecogniser
      gets a set of entity types whose names are recognisable by this
      Specified by:
      getEntityTypes in interface NERecogniser
      Returns:
      set of entity types/classes

    • recognise

      public Map<String,Set<String>> recognise(String text)
      Description copied from interface: NERecogniser
      call for name recognition action from text
      Specified by:
      recognise in interface NERecogniser
      Parameters:
      text - text with possibly contains names
      Returns:
      map of entityType -> set of names

    • findNames

      public Map<String,Set<String>> findNames(String[] tokens)
      finds names from given array of tokens
      Parameters:
      tokens - the tokens array
      Returns:
      map of EntityType -> set of entity names