Package org.apache.poi.hssf.record
Class RecordFactory
java.lang.Object
org.apache.poi.hssf.record.RecordFactory
Title: Record Factory
Description: Takes a stream and outputs an array of Record objects.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic BlankRecord[]
Converts aMulBlankRecord
into an equivalent array ofBlankRecords
static NumberRecord[]
Converts aMulRKRecord
into an equivalent array ofNumberRecords
static NumberRecord
RK record is a slightly smaller alternative to NumberRecord POI likes NumberRecord betterstatic Record[]
create a record, if there are MUL records than multiple records are returned digested into the non-mul form.Create an array of records from an input streamstatic Record
static short[]
getRecordClass
(int sid) Debug / diagnosis method
-
Constructor Details
-
RecordFactory
public RecordFactory()
-
-
Method Details
-
getRecordClass
Debug / diagnosis methodGets the POI implementation class for a given
sid
. Only a subset of the BIFF records are actually interpreted by POI. A few others are known but not interpreted (seeUnknownRecord.getBiffName(int)
).- Parameters:
sid
- the record sid- Returns:
- the POI implementation class for the specified record
sid
.null
if the specified record is not interpreted by POI.
-
createRecord
create a record, if there are MUL records than multiple records are returned digested into the non-mul form.- Parameters:
in
- the RecordInputStream to read from- Returns:
- the extracted records
-
createSingleRecord
-
convertToNumberRecord
RK record is a slightly smaller alternative to NumberRecord POI likes NumberRecord better- Parameters:
rk
- the RK record to convert- Returns:
- the NumberRecord
-
convertRKRecords
Converts aMulRKRecord
into an equivalent array ofNumberRecords
- Parameters:
mrk
- the MulRKRecord to convert- Returns:
- the equivalent array of
NumberRecords
-
convertBlankRecords
Converts aMulBlankRecord
into an equivalent array ofBlankRecords
- Parameters:
mbk
- the MulBlankRecord to convert- Returns:
- the equivalent array of
BlankRecords
-
getAllKnownRecordSIDs
public static short[] getAllKnownRecordSIDs()- Returns:
- an array of all the SIDS for all known records
-
createRecords
Create an array of records from an input stream- Parameters:
in
- the InputStream from which the records will be obtained- Returns:
- an array of Records created from the InputStream
- Throws:
RecordFormatException
- on error processing the InputStream
-