Package opennlp.tools.postag

Class POSDictionary

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static POSDictionary create​(java.io.InputStream in)
      Creates a new POSDictionary from a provided InputStream.
      boolean equals​(java.lang.Object obj)  
      java.lang.Class<?> getArtifactSerializerClass()
      Retrieves the class which can serialize and recreate this artifact.
      java.lang.String[] getTags​(java.lang.String word)
      Returns a list of valid tags for the specified word.
      int hashCode()  
      boolean isCaseSensitive()
      Whether if the dictionary is case sensitive or not
      java.util.Iterator<java.lang.String> iterator()
      Retrieves an iterator over all words in the dictionary.
      java.lang.String[] put​(java.lang.String word, java.lang.String... tags)
      Associates the specified tags with the specified word.
      void serialize​(java.io.OutputStream out)
      Writes the POSDictionary to the given OutputStream; After the serialization is finished the provided OutputStream remains open.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator

    • Constructor Detail

      • POSDictionary

        public POSDictionary()
        Initializes an empty case sensitive POSDictionary.

      • POSDictionary

        public POSDictionary​(boolean caseSensitive)
        Initializes an empty POSDictionary.
        Parameters:
        caseSensitive - the POSDictionary case sensitivity

    • Method Detail

      • getTags

        public java.lang.String[] getTags​(java.lang.String word)
        Returns a list of valid tags for the specified word.
        Specified by:
        getTags in interface TagDictionary
        Parameters:
        word - The word.
        Returns:
        A list of valid tags for the specified word or null if no information is available for that word.

      • iterator

        public java.util.Iterator<java.lang.String> iterator()
        Retrieves an iterator over all words in the dictionary.
        Specified by:
        iterator in interface java.lang.Iterable<java.lang.String>

      • serialize

        public void serialize​(java.io.OutputStream out)
               throws java.io.IOException
        Writes the POSDictionary to the given OutputStream; After the serialization is finished the provided OutputStream remains open.
        Parameters:
        out - the OutputStream to write the dictionary into.
        Throws:
        java.io.IOException - if writing to the OutputStream fails

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • create

        public static POSDictionary create​(java.io.InputStream in)
                            throws java.io.IOException
        Creates a new POSDictionary from a provided InputStream. After creation is finished the provided InputStream is closed.
        Parameters:
        in -
        Returns:
        the pos dictionary
        Throws:
        java.io.IOException
        InvalidFormatException

      • put

        public java.lang.String[] put​(java.lang.String word,
                              java.lang.String... tags)
        Description copied from interface: MutableTagDictionary
        Associates the specified tags with the specified word. If the dictionary previously contained keys for the word, the old tags are replaced by the specified tags.
        Specified by:
        put in interface MutableTagDictionary
        Parameters:
        word - word with which the specified tags is to be associated
        tags - tags to be associated with the specified word
        Returns:
        the previous tags associated with the word, or null if there was no mapping for word.

      • isCaseSensitive

        public boolean isCaseSensitive()
        Description copied from interface: MutableTagDictionary
        Whether if the dictionary is case sensitive or not
        Specified by:
        isCaseSensitive in interface MutableTagDictionary
        Returns:
        true if the dictionary is case sensitive

      • getArtifactSerializerClass

        public java.lang.Class<?> getArtifactSerializerClass()
        Description copied from interface: SerializableArtifact
        Retrieves the class which can serialize and recreate this artifact.
        Note: The serializer class must have a public zero argument constructor or an exception is thrown during model serialization/loading.
        Specified by:
        getArtifactSerializerClass in interface SerializableArtifact
        Returns:
        the corresponding ArtifactSerializer class.