Interface Scan.VirtualDocumentFragment

  • All Superinterfaces:
    Serializable
    All Known Implementing Classes:
    AnchorExtractor.Anchor
    Enclosing class:
    Scan

    public static interface Scan.VirtualDocumentFragment
    extends Serializable
    An interface that describes a virtual document fragment. When indexing in Scan.IndexingType.VIRTUAL mode, documents are composed by fragments (typically, some text surrounding an anchor) that are referred to a document by some spefication (in the previous case, the content href attribute of the anchor). This interface is used to describe such fragments (see, e.g., AnchorExtractor).
    See Also:
    VirtualDocumentResolver
    • Method Summary

      Modifier and Type Method Description
      MutableString documentSpecifier()
      The specification of the document to which this fragment belong.
      MutableString text()
      The textual content of this fragment.
    • Method Detail

      • documentSpecifier

        MutableString documentSpecifier()
        The specification of the document to which this fragment belong.
        Returns:
        the specification of the document to which this fragment belong.
        See Also:
        VirtualDocumentResolver
      • text

        MutableString text()
        The textual content of this fragment.
        Returns:
        the textual content of this fragment.