Package net.anotheria.asg.util.filter

Class MissingAnyTranslationFilter

  • All Implemented Interfaces:
    DocumentFilter
    public class MissingAnyTranslationFilter
extends java.lang.Object
implements DocumentFilter
    Missing Any Translation Filter. Pass documents if any of properties: - multilanguage support is enabled - value for default language (context.xml) is set. - value for selected language (selectable in filter) is not set (empty) Using: The main feature of this filter realization is that attributeName is ignored in mayPass() method, so viewdef filter definition may be not linked with real field, for example: <filter name="MissingAnyTranslation" field="Any" /> or <filter name="MissingAnyTranslation" field="*" />
    Version:
    $Id: $Id
    Author:
    another

    • Constructor Summary

      Constructors 
      Constructor Description
      MissingAnyTranslationFilter()
      Default constructor, sets supportedLanguages and defaultLanguage from CallContext This constructor will be used in generated applications.
      MissingAnyTranslationFilter​(java.util.List<java.lang.String> supportedLanguages, java.lang.String defaultLanguage)
      Constructor with parameters.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDefaultLanguage()
      Getter for the field defaultLanguage.
      java.util.List<java.lang.String> getSupportedLanguages()
      Getter for the field supportedLanguages.
      java.util.List<FilterTrigger> getTriggerer​(java.lang.String storedFilterParameter)
      getTriggerer.
      boolean mayPass​(DataObject document, java.lang.String attributeName, java.lang.String filterParameter)
      Returns true if the document may pass the filtering defined by applying the filter parameter to the attribute with filters internal rule.
      void setDefaultLanguage​(java.lang.String defaultLanguage)
      Setter for the field defaultLanguage.
      void setSupportedLanguages​(java.util.List<java.lang.String> supportedLanguages)
      Set supported languages.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • MissingAnyTranslationFilter

        public MissingAnyTranslationFilter()
        Default constructor, sets supportedLanguages and defaultLanguage from CallContext This constructor will be used in generated applications. If CallContext can not be got by ContextManager, default language and supported languages will be setted to "EN"

      • MissingAnyTranslationFilter

        public MissingAnyTranslationFilter​(java.util.List<java.lang.String> supportedLanguages,
                                   java.lang.String defaultLanguage)
        Constructor with parameters. May be used for unit test.
        Parameters:
        supportedLanguages - a List object.
        defaultLanguage - a String object.

    • Method Detail

      • getTriggerer

        public java.util.List<FilterTrigger> getTriggerer​(java.lang.String storedFilterParameter)

        getTriggerer.

        Specified by:
        getTriggerer in interface DocumentFilter
        Parameters:
        storedFilterParameter - a String object.
        Returns:
        the list of triggerers

      • mayPass

        public boolean mayPass​(DataObject document,
                       java.lang.String attributeName,
                       java.lang.String filterParameter)
        Returns true if the document may pass the filtering defined by applying the filter parameter to the attribute with filters internal rule.
        Specified by:
        mayPass in interface DocumentFilter
        Parameters:
        document - a DataObject object.
        attributeName - a String object.
        filterParameter - a String object.
        Returns:
        a boolean.

      • setSupportedLanguages

        public void setSupportedLanguages​(java.util.List<java.lang.String> supportedLanguages)
        Set supported languages. Method update triggers. NOTE: Default language will not be included into triggers.
        Parameters:
        supportedLanguages - a List object.

      • getSupportedLanguages

        public java.util.List<java.lang.String> getSupportedLanguages()

        Getter for the field supportedLanguages.

        Returns:
        a List object.

      • setDefaultLanguage

        public void setDefaultLanguage​(java.lang.String defaultLanguage)

        Setter for the field defaultLanguage.

        Parameters:
        defaultLanguage - a String object.

      • getDefaultLanguage

        public java.lang.String getDefaultLanguage()

        Getter for the field defaultLanguage.

        Returns:
        a String object.