Package com.e1c.langtool.collector

Interface ICollectingParameters

All Known Implementing Classes:
CollectingParameters
public interface ICollectingParameters
The Interface for collecting parameters. The implementation must be set to FeatureValueCollector before the collector start process.
See Also:

  • Field Details

    • DEFAULT

      static final ICollectingParameters DEFAULT
      The default light parameters for collecting features from single object.

  • Method Details

    • isCollectChildObjects

      boolean isCollectChildObjects()
      Checks if it is collecting child objects.
      Returns:
      true to collect FeatureValue from child objects

    • isCollectModelStrings

      boolean isCollectModelStrings()
      Checks if it is collecting model strings.
      Returns:
      true to collect model (none localizable) EFeatureSettings strings

    • isCollectInterfaceStrings

      boolean isCollectInterfaceStrings()
      Checks if it is collecting interface strings.
      Returns:
      true to collect interface or localizable EFeatureSettings strings

    • getCollectModelType

      ICollectingParameters.CollectModelType getCollectModelType()
      Gets the collect model type: any (include computed) strings, model strings that are non computed or model strings that are computed strings.
      Returns:
      the collect model type

    • isCollectSubResources

      boolean isCollectSubResources()
      Checks if it is collecting in sub resources.
      Returns:
      true to collect in sub resources. It depends on concrete project implementation, some child objects could be store in different resources.

    • getLanguages

      Set<TranslateLanguage> getLanguages()
      Gets the languages which collecting from source object.
      Returns:
      the set of TranslateLanguage to collect from source and add to FeatureValue.getLocalStrings() with language code, cannot be null.

    • isCollectEmptyValue

      boolean isCollectEmptyValue()
      Checks if it is collecting FeatureValue with empty values.
      Returns:
      true, if it is collecting empty value

    • isContinueAfterFirstError

      boolean isContinueAfterFirstError()
      Checks if collecting should continue after first error.
      Returns:
      true, if it should continue after first error

    • getErrors

      Collection<Exception> getErrors()
      Gets the errors which collected if isContinueAfterFirstError() set to true.
      Returns:
      the errors

    • getFilterParameters

      default Map<String,Object> getFilterParameters()
      Gets the filter parameters.
      Returns:
      the filter parameters

    • useCache

      boolean useCache()
      Use cached FeatureValue for the resource and for all it's child objects.
      Returns:
      true, if need to use cache if available for the resource

    • isKeepLanguagesMode

      boolean isKeepLanguagesMode()
      Checks if is keep languages mode.
      Returns:
      true, if is keep languages mode