Interface RFile.SummaryOptions
-
- All Known Subinterfaces:
RFile.SummaryFSOptions
- Enclosing class:
- RFile
public static interface RFile.SummaryOptions
This is an intermediate interface in a large builder pattern. Allows setting options for retrieving summary data.- Since:
- 2.0.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description RFile.SummaryOptions
endRow(CharSequence endRow)
RFile.SummaryOptions
endRow(org.apache.hadoop.io.Text endRow)
Summary data may possibly be stored at a more granular level than the entire file.Collection<Summary>
read()
Reads summary data from file.RFile.SummaryOptions
selectSummaries(Predicate<SummarizerConfiguration> summarySelector)
This method allows retrieving a subset of summary data from a file.RFile.SummaryOptions
startRow(CharSequence startRow)
RFile.SummaryOptions
startRow(org.apache.hadoop.io.Text startRow)
Summary data may possibly be stored at a more granular level than the entire file.RFile.SummaryOptions
withTableProperties(Iterable<Map.Entry<String,String>> props)
Retrieve summaries with provided tables properties.RFile.SummaryOptions
withTableProperties(Map<String,String> props)
-
-
-
Method Detail
-
withTableProperties
RFile.SummaryOptions withTableProperties(Iterable<Map.Entry<String,String>> props)
Retrieve summaries with provided tables properties. Properties for a table can be obtained by callingTableOperations.getProperties(String)
. Any property that impacts file behavior regardless of whether it has theProperty.TABLE_PREFIX
may be accepted and used. For example, cache and crypto properties could be passed here.- Parameters:
props
- iterable over Accumulo table key value properties.- Returns:
- this
-
withTableProperties
RFile.SummaryOptions withTableProperties(Map<String,String> props)
- Parameters:
props
- a map instead of an Iterable- Returns:
- this
- See Also:
Any property that impacts file behavior regardless of whether it has the may be accepted and used. For example, cache and crypto properties could be passed here.
-
selectSummaries
RFile.SummaryOptions selectSummaries(Predicate<SummarizerConfiguration> summarySelector)
This method allows retrieving a subset of summary data from a file. If a file has lots of separate summaries, reading a subset may be faster.- Parameters:
summarySelector
- Only read summary data that was generated with configuration that this predicate matches.- Returns:
- this
-
startRow
RFile.SummaryOptions startRow(org.apache.hadoop.io.Text startRow)
Summary data may possibly be stored at a more granular level than the entire file. However there is no guarantee of this. If the data was stored at a more granular level, then this will get a subset of the summary data. The subset will very likely be an inaccurate approximation.- Parameters:
startRow
- A non-null start row. The startRow is used exclusively.- Returns:
- this
- See Also:
Summary.FileStatistics.getExtra()
-
startRow
RFile.SummaryOptions startRow(CharSequence startRow)
- Parameters:
startRow
- UTF-8 encodes startRow. The startRow is used exclusively.- Returns:
- this
- See Also:
startRow(Text)
-
endRow
RFile.SummaryOptions endRow(org.apache.hadoop.io.Text endRow)
Summary data may possibly be stored at a more granular level than the entire file. However there is no guarantee of this. If the data was stored at a more granular level, then this will get a subset of the summary data. The subset will very likely be an inaccurate approximation.- Parameters:
endRow
- A non-null end row. The end row is used inclusively.- Returns:
- this
- See Also:
Summary.FileStatistics.getExtra()
-
endRow
RFile.SummaryOptions endRow(CharSequence endRow)
- Parameters:
endRow
- UTF-8 encodes endRow. The end row is used inclusively.- Returns:
- this
- See Also:
endRow(Text)
-
read
Collection<Summary> read() throws IOException
Reads summary data from file.- Returns:
- The summary data in the file that satisfied the selection criteria.
- Throws:
IOException
-
-