/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.nifi.provenance.serialization;
import java.io.Closeable;
import java.io.IOException;
import java.util.Optional;
import org.apache.nifi.provenance.ProvenanceEventRecord;
import org.apache.nifi.provenance.StandardProvenanceEventRecord;
import org.apache.nifi.provenance.toc.TocReader;
public interface RecordReader extends Closeable {
/**
* Returns the next record in the reader, or <code>null</code> if there is no more data available.
* @return the next Provenance event in the stream
* @throws IOException if unable to read the next event from the stream
*/
StandardProvenanceEventRecord nextRecord() throws IOException;
/**
* Skips the specified number of bytes
* @param bytesToSkip the number of bytes to skip ahead
* @throws IOException if unable to skip ahead the specified number of bytes (e.g., the stream does
* not contain this many more bytes)
*/
void skip(long bytesToSkip) throws IOException;
/**
* Skips to the specified byte offset in the underlying stream.
* @param position the byte offset to skip to
* @throws IOException if the underlying stream throws IOException, or if the reader has already
* passed the specified byte offset
*/
void skipTo(long position) throws IOException;
/**
* Skips to the specified compression block
*
* @param blockIndex the block index to skip to
* @throws IOException if the underlying stream throws IOException, or if the reader has already
* read passed the specified compression block index
* @throws IllegalStateException if the RecordReader does not have a TableOfContents associated with it
*/
void skipToBlock(int blockIndex) throws IOException;
/**
* Skips to the first event in the stream with an Event ID >= the given ID. If no event is found with an
* ID >= the given ID an empty Optional is returned. Otherwise, an Optional containing the first event in the stream with an
* ID >= the given ID is returned. Unlike {@link #nextRecord()}, this method does not consume the returned event from the stream.
* I.e., if a record is returned, that same record will be returned again the next time that {@link #nextRecord()} is called.
*
* @param eventId the ID of the event to retrieve
* @return the first event in the stream with an Event ID >= the given ID or an empty Optional if no such event can be found
* @throws IOException if the underlying stream throws IOException
*/
Optional<ProvenanceEventRecord> skipToEvent(long eventId) throws IOException;
/**
* Returns the block index that the Reader is currently reading from.
* Note that the block index is incremented at the beginning of the {@link #nextRecord()}
* method. This means that this method will return the block from which the previous record was read,
* if calling {@link #nextRecord()} continually, not the block from which the next record will be read.
*
* @return the current block index
* @throws IllegalStateException if the reader is reading a provenance event file that does not contain
* a Table of Contents
*/
int getBlockIndex();
/**
* Returns <code>true</code> if the compression block index is available. It will be available
* if and only if the reader is created with a TableOfContents
*
* @return true if the reader is reading from an event file that has a Table of Contents
*/
boolean isBlockIndexAvailable();
/**
* Returns the {@link TocReader} that is used to keep track of compression blocks, if one exists,
* <code>null</code> otherwise
*
* @return the TocReader if the underlying event file has an Table of Contents, <code>null</code> otherwise.
*/
TocReader getTocReader();
/**
* @return the number of bytes that have been consumed from the stream (read or skipped).
*/
long getBytesConsumed();
/**
* Returns the ID of the last event in this record reader, or -1 if the reader has no records or
* has already read through all records. Note: This method will consume the stream until the end,
* so no more records will be available on this reader after calling this method.
*
* @return the ID of the last event in this record reader, or -1 if the reader has no records or
* has already read through all records
* @throws IOException if unable to get id of the last event
*/
long getMaxEventId() throws IOException;
/**
* Returns <code>true</code> if there is more data for hte Record Reader to read, <code>false</code> otherwise.
*
* @return <code>true</code> if there is more data for hte Record Reader to read, <code>false</code> otherwise.
*/
boolean isData();
}