Package loci.poi.hssf.record
Class WriteAccessRecord
- java.lang.Object
-
- loci.poi.hssf.record.Record
-
- loci.poi.hssf.record.WriteAccessRecord
-
public class WriteAccessRecord extends Record
Title: Write Access RecordDescription: Stores the username of that who owns the spreadsheet generator (on unix the user's login, on Windoze its the name you typed when you installed the thing)
REFERENCE: PG 424 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
- Version:
- 2.0-pre
- Author:
- Andrew C. Oliver (acoliver at apache dot org)
-
-
Field Summary
Fields Modifier and Type Field Description static short
sid
-
Constructor Summary
Constructors Constructor Description WriteAccessRecord()
WriteAccessRecord(RecordInputStream in)
Constructs a WriteAccess record and sets its fields appropriately.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
fillFields(RecordInputStream in)
called by the constructor, should set class level fields.int
getRecordSize()
gives the current serialized size of the record.short
getSid()
return the non static version of the id for this record.String
getUsername()
get the username for the user that created the report.int
serialize(int offset, byte[] data)
called by the class that is responsible for writing this sucker.void
setUsername(String username)
set the username for the user that created the report.String
toString()
get a string representation of the record (for biffview/debugging)protected void
validateSid(short id)
called by constructor, should throw runtime exception in the event of a record passed with a differing ID.-
Methods inherited from class loci.poi.hssf.record.Record
clone, isInValueSection, isValue, serialize
-
-
-
-
Field Detail
-
sid
public static final short sid
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
WriteAccessRecord
public WriteAccessRecord()
-
WriteAccessRecord
public WriteAccessRecord(RecordInputStream in)
Constructs a WriteAccess record and sets its fields appropriately.- Parameters:
in
- the RecordInputstream to read the record from
-
-
Method Detail
-
validateSid
protected void validateSid(short id)
Description copied from class:Record
called by constructor, should throw runtime exception in the event of a record passed with a differing ID.- Specified by:
validateSid
in classRecord
- Parameters:
id
- alleged id for this record
-
fillFields
protected void fillFields(RecordInputStream in)
Description copied from class:Record
called by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.- Specified by:
fillFields
in classRecord
- Parameters:
in
- the RecordInputstream to read the record from
-
setUsername
public void setUsername(String username)
set the username for the user that created the report. HSSF uses the logged in user.- Parameters:
username
- of the user who is logged in (probably "tomcat" or "apache")
-
getUsername
public String getUsername()
get the username for the user that created the report. HSSF uses the logged in user. On natively created M$ Excel sheet this would be the name you typed in when you installed it in most cases.- Returns:
- username of the user who is logged in (probably "tomcat" or "apache")
-
toString
public String toString()
Description copied from class:Record
get a string representation of the record (for biffview/debugging)
-
serialize
public int serialize(int offset, byte[] data)
Description copied from class:Record
called by the class that is responsible for writing this sucker. Subclasses should implement this so that their data is passed back in a byte array.
-
getRecordSize
public int getRecordSize()
Description copied from class:Record
gives the current serialized size of the record. Should include the sid and reclength (4 bytes).- Overrides:
getRecordSize
in classRecord
-
-