io.annot8.common.data.content.Text Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of annot8-common-data Show documentation
Common data (bounds and content) definitions
The newest version!
/* Annot8 (annot8.io) - Licensed under Apache-2.0. */
package io.annot8.common.data.content;

import io.annot8.api.annotations.Annotation;
import io.annot8.api.bounds.Bounds;
import io.annot8.api.data.Content;
import io.annot8.common.data.bounds.SpanBounds;
import java.util.Optional;
import java.util.function.Predicate;
import java.util.stream.Stream;

/**
 * Represents plain text content having data of type string.
 *
 * This could the content of a document, a cell in a database, or anything else which is actual
 * text.
 *
 * Do not use this for non plain/text (eg HTML), as these have structure to be considered.
 */
public interface Text extends Content {

  /**
   * Get the text under the annotation, if the annotation's bounds are of a supported type.
   *
   * @param annotation the annotation
   * @return the text under the annotation
   */
  default Optional getText(Annotation annotation) {
    Bounds bounds = annotation.getBounds();
    return bounds.getData(this, String.class);
  }

  /**
   * Get annotations between the offsets
   *
   * @param begin the start offset
   * @param end the end offset
   * @return annotations
   */
  default Stream getBetween(int begin, int end) {
    SpanBounds offset = new SpanBounds(begin, end);
    return filterAnnotations(SpanBounds.class, s -> offset.isWithin(s.getBegin(), s.getEnd()));
  }

  /**
   * Get Annotations covering the provided offset
   *
   * @param begin the start offset
   * @param end the end offset
   * @return annotations
   */
  default Stream getCovers(int begin, int end) {
    return filterAnnotations(SpanBounds.class, s -> s.isWithin(begin, end));
  }

  /**
   * Get annotations after the offset
   *
   * @param offset offset
   * @return annotations
   */
  default Stream getAfter(int offset) {
    return filterAnnotations(SpanBounds.class, s -> s.isAfter(offset));
  }

  /**
   * Get annotations before the offset
   *
   * @param offset offset
   * @return annotations
   */
  default Stream getBefore(int offset) {
    return filterAnnotations(SpanBounds.class, s -> s.isBefore(offset));
  }

  private  Stream filterAnnotations(
      Class boundsClass, Predicate predicate) {
    //noinspection OptionalGetWithoutIsPresent
    return getAnnotations()
        .getByBounds(boundsClass)
        .filter(a -> predicate.test(a.getBounds(boundsClass).get()));
  }
}