Package ai.pipestream.parsed.data.epub.v1

Interface EpubContentItemOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
EpubContentItem, EpubContentItem.Builder
@Generated public interface EpubContentItemOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getCharacterCount()
    Estimated character count for this content file
    String
    getHref()
    File path relative to OPF file location
    com.google.protobuf.ByteString
    getHrefBytes()
    File path relative to OPF file location
    String
    getId()
    Unique identifier for this content item (from manifest)
    com.google.protobuf.ByteString
    getIdBytes()
    Unique identifier for this content item (from manifest)
    boolean
    getIsLinear()
    Whether this item is linear (part of main reading flow)
    String
    getMediaType()
    MIME type of the content file
    com.google.protobuf.ByteString
    getMediaTypeBytes()
    MIME type of the content file
    String
    getProperties(int index)
    Properties associated with this spine item
    com.google.protobuf.ByteString
    getPropertiesBytes(int index)
    Properties associated with this spine item
    int
    getPropertiesCount()
    Properties associated with this spine item
    List<String>
    getPropertiesList()
    Properties associated with this spine item
    int
    getSpineIndex()
    Position in the reading order (0-based)
    String
    getTitle()
    Title or heading extracted from this content file
    com.google.protobuf.ByteString
    getTitleBytes()
    Title or heading extracted from this content file
    long
    getWordCount()
    Estimated word count for this content file
    boolean
    hasCharacterCount()
    Estimated character count for this content file
    boolean
    hasIsLinear()
    Whether this item is linear (part of main reading flow)
    boolean
    hasMediaType()
    MIME type of the content file
    boolean
    hasTitle()
    Title or heading extracted from this content file
    boolean
    hasWordCount()
    Estimated word count for this content file

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getId

      String getId()
       Unique identifier for this content item (from manifest)
      string id = 1 [json_name = "id"];
      Returns:
      The id.

    • getIdBytes

      com.google.protobuf.ByteString getIdBytes()
       Unique identifier for this content item (from manifest)
      string id = 1 [json_name = "id"];
      Returns:
      The bytes for id.

    • getHref

      String getHref()
       File path relative to OPF file location
      string href = 2 [json_name = "href"];
      Returns:
      The href.

    • getHrefBytes

      com.google.protobuf.ByteString getHrefBytes()
       File path relative to OPF file location
      string href = 2 [json_name = "href"];
      Returns:
      The bytes for href.

    • hasMediaType

      boolean hasMediaType()
       MIME type of the content file
      optional string media_type = 3 [json_name = "mediaType"];
      Returns:
      Whether the mediaType field is set.

    • getMediaType

      String getMediaType()
       MIME type of the content file
      optional string media_type = 3 [json_name = "mediaType"];
      Returns:
      The mediaType.

    • getMediaTypeBytes

      com.google.protobuf.ByteString getMediaTypeBytes()
       MIME type of the content file
      optional string media_type = 3 [json_name = "mediaType"];
      Returns:
      The bytes for mediaType.

    • getSpineIndex

      int getSpineIndex()
       Position in the reading order (0-based)
      int32 spine_index = 4 [json_name = "spineIndex"];
      Returns:
      The spineIndex.

    • hasIsLinear

      boolean hasIsLinear()
       Whether this item is linear (part of main reading flow)
      optional bool is_linear = 5 [json_name = "isLinear"];
      Returns:
      Whether the isLinear field is set.

    • getIsLinear

      boolean getIsLinear()
       Whether this item is linear (part of main reading flow)
      optional bool is_linear = 5 [json_name = "isLinear"];
      Returns:
      The isLinear.

    • getPropertiesList

      List<String> getPropertiesList()
       Properties associated with this spine item
      repeated string properties = 6 [json_name = "properties"];
      Returns:
      A list containing the properties.

    • getPropertiesCount

      int getPropertiesCount()
       Properties associated with this spine item
      repeated string properties = 6 [json_name = "properties"];
      Returns:
      The count of properties.

    • getProperties

      String getProperties(int index)
       Properties associated with this spine item
      repeated string properties = 6 [json_name = "properties"];
      Parameters:
      index - The index of the element to return.
      Returns:
      The properties at the given index.

    • getPropertiesBytes

      com.google.protobuf.ByteString getPropertiesBytes(int index)
       Properties associated with this spine item
      repeated string properties = 6 [json_name = "properties"];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the properties at the given index.

    • hasWordCount

      boolean hasWordCount()
       Estimated word count for this content file
      optional int64 word_count = 7 [json_name = "wordCount"];
      Returns:
      Whether the wordCount field is set.

    • getWordCount

      long getWordCount()
       Estimated word count for this content file
      optional int64 word_count = 7 [json_name = "wordCount"];
      Returns:
      The wordCount.

    • hasCharacterCount

      boolean hasCharacterCount()
       Estimated character count for this content file
      optional int64 character_count = 8 [json_name = "characterCount"];
      Returns:
      Whether the characterCount field is set.

    • getCharacterCount

      long getCharacterCount()
       Estimated character count for this content file
      optional int64 character_count = 8 [json_name = "characterCount"];
      Returns:
      The characterCount.

    • hasTitle

      boolean hasTitle()
       Title or heading extracted from this content file
      optional string title = 9 [json_name = "title"];
      Returns:
      Whether the title field is set.

    • getTitle

      String getTitle()
       Title or heading extracted from this content file
      optional string title = 9 [json_name = "title"];
      Returns:
      The title.

    • getTitleBytes

      com.google.protobuf.ByteString getTitleBytes()
       Title or heading extracted from this content file
      optional string title = 9 [json_name = "title"];
      Returns:
      The bytes for title.