Package com.e1c.langtool.history.provider

Interface IHistoryTranslationProvider.ITranslationResult

All Superinterfaces:
IPageIterable<IPage<IProjectTranslation>>, Iterable<IPage<IProjectTranslation>>
All Known Subinterfaces:
IScopedTranslationProvider.IScopedTranslationResult
All Known Implementing Classes:
BaseTranslationProvider.TranslationResult
Enclosing interface:
IHistoryTranslationProvider
public static interface IHistoryTranslationProvider.ITranslationResult extends IPageIterable<IPage<IProjectTranslation>>
The result of translation that contains all translations are grouped by translated value.

This result contains the translated value by which all translations have been grouped and the total count of these translations. Also it provides iterating over pages that contain all found translations.

See Also:

  • Method Details

    • totalCount

      long totalCount()
      Returns the total count of translation which have been found for the query.
      Returns:
      the total count of translation (must be positive)

    • value

      String value()
      The result of translation.

      The implementors of this interface must provide that the result of translation returned from this method must be the same with all translations contained in iterable pages returned from iterators (see iterator() and iterator(int) methods).

      Returns:
      the translation result (must not be null)

    • iterator

      Iterator<IPage<IProjectTranslation>> iterator()
      Returns an iterator over of pages that contain translations.

      This method returns an iterator that allows to iterate over pages with translations in lazy way. The page size is defined by implementators of this interface. To define the size of iterating pages use the iterator(int) method.

      Note that implementators of this interface may realize the lazy way of page loading through iterating so it's recommended avoiding a redundant passes over iterator because of overhead for creating the iterator and loading pages.

      Specified by:
      iterator in interface Iterable<IPage<IProjectTranslation>>
      Returns:
      an iterator of pages
      See Also:

    • iterator

      Iterator<IPage<IProjectTranslation>> iterator(int pageSize)
      Returns an iterator over of pages that contain translations with the specified page size.

      This method returns an iterator that allows to iterate over pages with translations in lazy way. Unlike iterator() this method allows users to specify the size of iterable pages.

      Note that implementators of this interface may realize the lazy way of page loading through iterating so it's recommended avoiding a redundant passes over iterator because of overhead for creating the iterator and loading pages.

      Specified by:
      iterator in interface IPageIterable<IPage<IProjectTranslation>>
      Parameters:
      pageSize - the size of iterable pages
      Returns:
      an iterator of pages (must be positive)
      Throws:
      IllegalArgumentException - if the given page size is not positive
      See Also: