Modifier and Type	Class and Description
public class	BandSet.BandAnalysisResults Results obtained by trying different Codecs to encode a band
public class	BandSet.BandData BandData represents information about a band, e.g. largest value etc and is used in the heuristics that calculate whether an alternative Codec could make the encoded band smaller.

Modifier and Type	Field and Description
private long[]	canonicalLargest
private long[]	canonicalSmallest
pack-priv final int	effort
private static final int[]	effortThresholds
private static final byte[]	EMPTY_BYTE_ARRAY
protected final SegmentHeader	segmentHeader

Access	Constructor and Description
public	BandSet(final int - the packing effort to be used (must be 1-9) effort, final SegmentHeader - the segment header header) Constructs a new BandSet.

Method Summary

Modifier and Type	Method and Description
private BandSet.BandAnalysisResults	analyseBand(final String name, final int[] band, final BHSDCodec defaultCodec)
protected int[]	Returns: conversion result. cpEntryListToArray(final List<? extends ConstantPoolEntry> conversion source. list) Converts a list of ConstantPoolEntrys to an int[] array of their indices
protected int[]	Returns: conversion result. cpEntryOrNullListToArray(final List<? extends ConstantPoolEntry> conversion source. list) Converts a list of ConstantPoolEntrys or nulls to an int[] array of their indices +1 (or 0 for nulls)
public byte[]	Returns: the encoded band encodeBandInt(final String - name of the band (used for debugging) name, final int[] - the band ints, final BHSDCodec - the default Codec defaultCodec) Encode a band of integers.
protected byte[]	Returns: the encoded band encodeFlags(final String - name of the band (for debugging purposes) name, final long[] - the band flags, final BHSDCodec - Codec for the low 32-bits band loCodec, final BHSDCodec - Codec for the high 32-bits band hiCodec, final boolean - ignores the high band if true as all values would be zero haveHiFlags) Encode a band of longs (values are split into their high and low 32 bits and then encoded as two separate bands
protected byte[]	encodeFlags(final String name, final long[][] flags, final BHSDCodec loCodec, final BHSDCodec hiCodec, final boolean haveHiFlags)
public byte[]	Returns: the encoded value encodeScalar(final int - the value to encode value, final BHSDCodec - Codec to use codec) Encode a single value with the given Codec
public byte[]	Returns: the encoded band encodeScalar(final int[] - the band band, final BHSDCodec - the Codec to use codec) Encode a band without considering other Codecs
private void	encodeWithPopulationCodec(final String name, final int[] band, final BHSDCodec defaultCodec, final BandSet.BandData bandData, final BandSet.BandAnalysisResults results)
private long[]	flatten(final long[][] flags)
protected int[]	Returns: conversion result. integerListToArray(final List<Integer> conversion source. integerList) Converts a list of Integers to an int[] array.
protected long[]	Returns: conversion result. longListToArray(final List<Long> conversion source. longList) Converts a list of Longs to an long[] array.
public abstract void	pack(OutputStream TODO out) Write the packed set of bands to the given output stream
private boolean	timeToStop(final BandSet.BandAnalysisResults results)
private void	tryCodecs(final String name, final int[] band, final BHSDCodec defaultCodec, final BandSet.BandData bandData, final BandSet.BandAnalysisResults results, final byte[] encoded, final BHSDCodec[] potentialCodecs)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

canonicalLargest	back to summary
private long[] canonicalLargest

canonicalSmallest	back to summary
private long[] canonicalSmallest

effort	back to summary
pack-priv final int effort

effortThresholds	back to summary
private static final int[] effortThresholds

EMPTY_BYTE_ARRAY	back to summary
private static final byte[] EMPTY_BYTE_ARRAY

segmentHeader	back to summary
protected final SegmentHeader segmentHeader

Constructor Detail

BandSet	back to summary
public BandSet(final int effort, final SegmentHeader header) Constructs a new BandSet. Parameters effort:int - the packing effort to be used (must be 1-9) header:SegmentHeader - the segment header

BandSet

back to summary

public BandSet(final int effort, final SegmentHeader header)

Constructs a new BandSet.

Parameters

effort:int: - the packing effort to be used (must be 1-9)
header:SegmentHeader: - the segment header

Method Detail

analyseBand	back to summary
private BandSet.BandAnalysisResults analyseBand(final String name, final int[] band, final BHSDCodec defaultCodec) throws Pack200Exception

cpEntryListToArray	back to summary
protected int[] cpEntryListToArray(final List<? extends ConstantPoolEntry> list) Converts a list of ConstantPoolEntrys to an int[] array of their indices Parameters list:List<? extends ConstantPoolEntry> conversion source. Returns:int[] conversion result.

cpEntryListToArray

back to summary

protected int[] cpEntryListToArray(final List<? extends ConstantPoolEntry> list)

Converts a list of ConstantPoolEntrys to an int[] array of their indices

Parameters

list:List<? extends ConstantPoolEntry>: conversion source.

Returns:int[]

conversion result.

cpEntryOrNullListToArray	back to summary
protected int[] cpEntryOrNullListToArray(final List<? extends ConstantPoolEntry> list) Converts a list of ConstantPoolEntrys or nulls to an int[] array of their indices +1 (or 0 for nulls) Parameters list:List<? extends ConstantPoolEntry> conversion source. Returns:int[] conversion result.

cpEntryOrNullListToArray

back to summary

protected int[] cpEntryOrNullListToArray(final List<? extends ConstantPoolEntry> list)

Converts a list of ConstantPoolEntrys or nulls to an int[] array of their indices +1 (or 0 for nulls)

Parameters

list:List<? extends ConstantPoolEntry>: conversion source.

Returns:int[]

conversion result.

encodeBandInt	back to summary
public byte[] encodeBandInt(final String name, final int[] ints, final BHSDCodec defaultCodec) throws Pack200Exception Encode a band of integers. The default codec may be used, but other Codecs are considered if effort is greater than 1. Parameters name:String - name of the band (used for debugging) ints:int[] - the band defaultCodec:BHSDCodec - the default Codec Returns:byte[] the encoded band Exceptions Pack200Exception: TODO

encodeBandInt

back to summary

public byte[] encodeBandInt(final String name, final int[] ints, final BHSDCodec defaultCodec) throws Pack200Exception

Encode a band of integers. The default codec may be used, but other Codecs are considered if effort is greater than 1.

Parameters

name:String: - name of the band (used for debugging)
ints:int[]: - the band
defaultCodec:BHSDCodec: - the default Codec

Returns:byte[]

the encoded band

Exceptions

Pack200Exception:: TODO

encodeFlags	back to summary
protected byte[] encodeFlags(final String name, final long[] flags, final BHSDCodec loCodec, final BHSDCodec hiCodec, final boolean haveHiFlags) throws Pack200Exception Encode a band of longs (values are split into their high and low 32 bits and then encoded as two separate bands Parameters name:String - name of the band (for debugging purposes) flags:long[] - the band loCodec:BHSDCodec - Codec for the low 32-bits band hiCodec:BHSDCodec - Codec for the high 32-bits band haveHiFlags:boolean - ignores the high band if true as all values would be zero Returns:byte[] the encoded band Exceptions Pack200Exception: TODO

encodeFlags

back to summary

protected byte[] encodeFlags(final String name, final long[] flags, final BHSDCodec loCodec, final BHSDCodec hiCodec, final boolean haveHiFlags) throws Pack200Exception

Encode a band of longs (values are split into their high and low 32 bits and then encoded as two separate bands

Parameters

name:String: - name of the band (for debugging purposes)
flags:long[]: - the band
loCodec:BHSDCodec: - Codec for the low 32-bits band
hiCodec:BHSDCodec: - Codec for the high 32-bits band
haveHiFlags:boolean: - ignores the high band if true as all values would be zero

Returns:byte[]

the encoded band

Exceptions

Pack200Exception:: TODO

encodeFlags	back to summary
protected byte[] encodeFlags(final String name, final long[][] flags, final BHSDCodec loCodec, final BHSDCodec hiCodec, final boolean haveHiFlags) throws Pack200Exception

encodeScalar	back to summary
public byte[] encodeScalar(final int value, final BHSDCodec codec) throws Pack200Exception Encode a single value with the given Codec Parameters value:int - the value to encode codec:BHSDCodec - Codec to use Returns:byte[] the encoded value Exceptions Pack200Exception: TODO

encodeScalar

back to summary

public byte[] encodeScalar(final int value, final BHSDCodec codec) throws Pack200Exception

Encode a single value with the given Codec

Parameters

value:int: - the value to encode
codec:BHSDCodec: - Codec to use

Returns:byte[]

the encoded value

Exceptions

Pack200Exception:: TODO

encodeScalar	back to summary
public byte[] encodeScalar(final int[] band, final BHSDCodec codec) throws Pack200Exception Encode a band without considering other Codecs Parameters band:int[] - the band codec:BHSDCodec - the Codec to use Returns:byte[] the encoded band Exceptions Pack200Exception: TODO

encodeScalar

back to summary

public byte[] encodeScalar(final int[] band, final BHSDCodec codec) throws Pack200Exception

Encode a band without considering other Codecs

Parameters

band:int[]: - the band
codec:BHSDCodec: - the Codec to use

Returns:byte[]

the encoded band

Exceptions

Pack200Exception:: TODO

encodeWithPopulationCodec	back to summary
private void encodeWithPopulationCodec(final String name, final int[] band, final BHSDCodec defaultCodec, final BandSet.BandData bandData, final BandSet.BandAnalysisResults results) throws Pack200Exception

flatten	back to summary
private long[] flatten(final long[][] flags)

integerListToArray	back to summary
protected int[] integerListToArray(final List<Integer> integerList) Converts a list of Integers to an int[] array. Parameters integerList:List<Integer> conversion source. Returns:int[] conversion result.

integerListToArray

back to summary

protected int[] integerListToArray(final List<Integer> integerList)

Converts a list of Integers to an int[] array.

Parameters

integerList:List<Integer>: conversion source.

Returns:int[]

conversion result.

longListToArray	back to summary
protected long[] longListToArray(final List<Long> longList) Converts a list of Longs to an long[] array. Parameters longList:List<Long> conversion source. Returns:long[] conversion result.

longListToArray

back to summary

protected long[] longListToArray(final List<Long> longList)

Converts a list of Longs to an long[] array.

Parameters

longList:List<Long>: conversion source.

Returns:long[]

conversion result.

pack	back to summary
public abstract void pack(OutputStream out) throws IOException, Pack200Exception Write the packed set of bands to the given output stream Parameters out:OutputStream TODO Exceptions IOException: If an I/O error occurs. Pack200Exception: TODO

pack

back to summary

public abstract void pack(OutputStream out) throws IOException, Pack200Exception

Write the packed set of bands to the given output stream

Parameters

out:OutputStream: TODO

Exceptions

IOException:: If an I/O error occurs.
Pack200Exception:: TODO

timeToStop	back to summary
private boolean timeToStop(final BandSet.BandAnalysisResults results)

tryCodecs	back to summary
private void tryCodecs(final String name, final int[] band, final BHSDCodec defaultCodec, final BandSet.BandData bandData, final BandSet.BandAnalysisResults results, final byte[] encoded, final BHSDCodec[] potentialCodecs) throws Pack200Exception

org.apache.commons.compress.harmony.pack200 back to summary

public Class BandSet.BandAnalysisResults

Class Inheritance

extends Object

java.lang.Object
org.apache.commons.compress.harmony.pack200.BandSet.BandAnalysisResults

Results obtained by trying different Codecs to encode a band

Field Summary

Modifier and Type	Field and Description
private Codec	betterCodec
private byte[]	encodedBand
private int[]	extraMetadata
private int	numCodecsTried
private int	saved

Constructor Summary

Access	Constructor and Description
public	BandAnalysisResults()

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

betterCodec	back to summary
private Codec betterCodec

encodedBand	back to summary
private byte[] encodedBand

extraMetadata	back to summary
private int[] extraMetadata

numCodecsTried	back to summary
private int numCodecsTried

saved	back to summary
private int saved

Constructor Detail

BandAnalysisResults	back to summary
public BandAnalysisResults()

org.apache.commons.compress.harmony.pack200 back to summary

public Class BandSet.BandData

Class Inheritance

extends Object

java.lang.Object
org.apache.commons.compress.harmony.pack200.BandSet.BandData

BandData represents information about a band, e.g. largest value etc and is used in the heuristics that calculate whether an alternative Codec could make the encoded band smaller.

Field Summary

Modifier and Type	Field and Description
private double	averageAbsoluteDelta
private double	averageAbsoluteValue
private final int[]	band
private int	deltaIsAscending
private Map<Integer, Integer>	distinctValues
private int	largest
private int	largestDelta
private int	smallDeltaCount
private int	smallest
private int	smallestDelta

Constructor Summary

Access	Constructor and Description
public	BandData(final int[] - the band of integers band) Constructs a new instance of BandData.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: true if any band elements are negative. anyNegatives() Returns true if any band elements are negative.
public boolean	Returns: true if the band deltas are mainly positive (heuristic). mainlyPositiveDeltas() Returns true if the band deltas are mainly positive (heuristic).
public boolean	Returns: true if the deltas between adjacent band elements are mainly small (heuristic). mainlySmallDeltas() Returns true if the deltas between adjacent band elements are mainly small (heuristic).
public int	Returns: the total number of distinct values found in the band. numDistinctValues() Returns the total number of distinct values found in the band.
public boolean	Returns: true if the band is well correlated (i.e. would be suitable for a delta encoding) (heuristic). wellCorrelated() Returns true if the band is well correlated (i.e. would be suitable for a delta encoding) (heuristic).

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

averageAbsoluteDelta	back to summary
private double averageAbsoluteDelta

averageAbsoluteValue	back to summary
private double averageAbsoluteValue

band	back to summary
private final int[] band

deltaIsAscending	back to summary
private int deltaIsAscending

distinctValues	back to summary
private Map<Integer, Integer> distinctValues

largest	back to summary
private int largest

largestDelta	back to summary
private int largestDelta

smallDeltaCount	back to summary
private int smallDeltaCount

smallest	back to summary
private int smallest

smallestDelta	back to summary
private int smallestDelta

Constructor Detail

BandData	back to summary
public BandData(final int[] band) Constructs a new instance of BandData. The band is then analysed. Parameters band:int[] - the band of integers

BandData

back to summary

public BandData(final int[] band)

Constructs a new instance of BandData. The band is then analysed.

Parameters

band:int[]: - the band of integers

Method Detail

anyNegatives	back to summary
public boolean anyNegatives() Returns true if any band elements are negative. Returns:boolean true if any band elements are negative.

anyNegatives

back to summary

public boolean anyNegatives()

Returns true if any band elements are negative.

Returns:boolean: true if any band elements are negative.

mainlyPositiveDeltas	back to summary
public boolean mainlyPositiveDeltas() Returns true if the band deltas are mainly positive (heuristic). Returns:boolean true if the band deltas are mainly positive (heuristic).

mainlyPositiveDeltas

back to summary

public boolean mainlyPositiveDeltas()

Returns true if the band deltas are mainly positive (heuristic).

Returns:boolean: true if the band deltas are mainly positive (heuristic).

mainlySmallDeltas

back to summary

public boolean mainlySmallDeltas()

Returns true if the deltas between adjacent band elements are mainly small (heuristic).

Returns:boolean: true if the deltas between adjacent band elements are mainly small (heuristic).

numDistinctValues

back to summary

public int numDistinctValues()

Returns the total number of distinct values found in the band.

Returns:int: the total number of distinct values found in the band.

wellCorrelated

back to summary

public boolean wellCorrelated()

Returns true if the band is well correlated (i.e. would be suitable for a delta encoding) (heuristic).

Returns:boolean: true if the band is well correlated (i.e. would be suitable for a delta encoding) (heuristic).

public abstract Class BandSet

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class BandSet.BandAnalysisResults

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

public Class BandSet.BandData

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail