com.force.i18n.grammar.GrammaticalTermMap Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of grammaticus Show documentation

Localization Framework that allows grammatically correct renaming of nouns

There is a newer version: 1.2.30

package com.force.i18n.grammar;

import java.io.IOException;
import java.io.Serializable;
import java.util.Collection;
import java.util.Map;
import java.util.Set;

/**
 * Representation of map stores any {@link GrammaticalTerm} in LanguageDictionary.
 * Is a subset of Map but some other methods are added. 
 * Note that, not all implementation supports all methods. Updating this would not work for isSkinny=true, 
 * and also sequential access won't work if the implementation is not in-memory one.
 * 
 */
public interface GrammaticalTermMap extends Serializable {

    /**
     * Return true is skinny - immutable
     */
    default boolean isSkinny() {
        return false;
    }

    /**
     * Run validation in the values and make it skinny
     */
    default void validate() {
        for(Map.Entry e : entrySet()) {
            e.getValue().validate(e.getKey());
            e.getValue().makeSkinny();
        }
    }

    /**
     * make it skinny - in memory or another immutable solution 
     * @return
     */
    GrammaticalTermMap makeSkinny();

    /**
     * set of keys
     */
    Set keySet();

    /**
     * true if this key exists
     * @param name
     * @return
     */
    boolean containsKey(String name);
        
    /**
     * true if empty
     * @return
     */
    boolean isEmpty();

    /**
     * Get term from this map
     * @param name
     * @return
     */
    T get(String name);

    /**
     * entry set - not work if isSkinny=true.
     */
    void put(String k, T v);
    
    /**
     * entry set - not work if isSkinny=true.
     */
    void putAll(GrammaticalTermMap other);

    /**
     * Get all terms in this map - not work if not in-memory case.
     */

    Collection values();

    /**
     * Get name - term pairs of this map - not work if not in-memory case.
     */
    Set> entrySet();
    
    /**
     * Write as json of this map - not work if not in-memory case.
     * 
     * @param out
     * @param renamingProvider
     * @param dictionary
     * @param termsToInclude
     * @throws IOException
     */
    void writeJson(Appendable out, RenamingProvider renamingProvider, LanguageDictionary dictionary, Collection termsToInclude) throws IOException;    
}