Storage (OpenXLS Java Spreadsheet SDK 11.0.4 API)

java.lang.Object
- io.starter.formats.LEO.BlockByteReader
- - io.starter.formats.LEO.Storage

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

RootStorage
```
public class Storage
extends BlockByteReader
```
Defines a 'file' in the LEO filesystem. contains pointers to Block storages as well as the storage type etc. Header (128 bytes): Directory Entry Name (64 bytes): This field MUST contain a Unicode string for the storage or stream name encoded in UTF-16. The name MUST be terminated with a UTF-16 terminating null character. Thus storage and stream names are limited to 32 UTF-16 code points, including the terminating null character. When locating an object in the compound file except for the root storage, the directory entry name is compared using a special case-insensitive upper-case mapping, described in Red-Black Tree. The following characters are illegal and MUST NOT be part of the name: '/', '\', ':', '!'. Directory Entry Name Length (2 bytes): This field MUST match the length of the Directory Entry Name Unicode string in bytes. The length MUST be a multiple of 2, and include the terminating null character in the count. This length MUST NOT exceed 64, the maximum size of the Directory Entry Name field. Object Type (1 byte): This field MUST be 0x00, 0x01, 0x02, or 0x05, depending on the actual type of object. All other values are not valid. 0= Unknown or unallocated 1= Storage Object 2- Stream Object 5= Root Storage Object Color Flag (1 byte): This field MUST be 0x00 (red) or 0x01 (black). All other values are not valid. Left Sibling ID (4 bytes): This field contains the Stream ID of the left sibling. If there is no left sibling, the field MUST be set to NOSTREAM (0xFFFFFFFF). Right Sibling ID (4 bytes): This field contains the Stream ID of the right sibling. If there is no right sibling, the field MUST be set to NOSTREAM (0xFFFFFFFF). Child ID (4 bytes): This field contains the Stream ID of a child object. If there is no child object, then the field MUST be set to NOSTREAM (0xFFFFFFFF). CLSID (16 bytes): This field contains an object classGUID, if this entry is a storage or root storage. If there is no object class GUID set on this object, then the field MUST be set to all zeroes. In a stream object, this field MUST be set to all zeroes. If not NULL, the object class GUID can be used as a parameter to launch applications. State Bits (4 bytes): This field contains the user-defined flags if this entry is a storage object or root storage object. If there are no state bits set on the object, then this field MUST be set to all zeroes. Creation Time (8 bytes): This field contains the creation time for a storage object. The Windows FILETIME structure is used to represent this field in UTC. If there is no creation time set on the object, this field MUST be all zeroes. For a root storage object, this field MUST be all zeroes, and the creation time is retrieved or set on the compound file itself. Modified Time (8 bytes): This field contains the modification time for a storage object. The Windows FILETIME structure is used to represent this field in UTC. If there is no modified time set on the object, this field MUST be all zeroes. For a root storage object, this field MUST be all zeroes, and the modified time is retrieved or set on the compound file itself. Starting Sector Location (4 bytes): This field contains the first sector location if this is a stream object. For a root storage object, this field MUST contain the first sector of the mini st ream, if the mini stream exists. Stream Size (8 bytes): This 64-bit integer field contains the size of the user-defined data, if this is a stream object. For a root storage object, this field contains the size of the mini stream. ?? offset type value const? function 00: stream $pps_rawname ! name of the pps 40: word $pps_sizeofname ! size of $pps_rawname 42: byte $pps_type ! type of pps (1=storage|2=stream|5=root) 43: byte $pps_uk0 ! ? 44: long $pps_prev ! previous pps 48: long $pps_next ! next pps 4c: long $pps_dir ! directory pps 50: stream 00 09 02 00 . ? 54: long 0 . ? 58: long c0 . ? 5c: stream 00 00 00 46 . ? 60: long 0 . ? 64: long $pps_ts1s ! timestamp 1 : "seconds" creation time 68: long $pps_ts1d ! timestamp 1 : "days" 6c: long $pps_ts2s ! timestamp 2 : "seconds" modified time 70: long $pps_ts2d ! timestamp 2 : "days" 74: long $pps_sb ! starting block of property 78: long $pps_size ! size of property 7c: long . ?

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`childStorageID`
`byte`	`directoryColor`
`boolean`	`miniStreamStorage`
`protected List`	`myblocks`
`int`	`nextStorageID`
`int`	`prevStorageID`
`byte`	`storageType`
`int`	`sz`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Storage()`
`protected`	`Storage(ByteBuffer buff)` create a new Storage record with a byte array containing its record headerData.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addBlock(Block b)` adds a block of data to this storage
`void`	`addIdx(int x)` Track BB Index info
`void`	`close()` clear out object references in prep for closing workbook
`boolean`	`equals(Object other)`
`int`	`getActualFileSize()` get the size of the Storage headerData
`BlockByteReader`	`getBlockReader()` returns a new BlockByteReader
`int`	`getBlockType()` returns whether this Storage's headerData blocks are contained in the Small or Big Block arrays.
`List`	`getBlockVect()`
`byte[]`	`getBytes()` return the underlying byte array for this Storage
`OutputStream`	`getByteStream()` return the underlying byte array for this Storage
`int`	`getChildStorageID()` get the value of the child storage id
`int`	`getDirectoryColor()`
`int`	`getFilePos()` get the position of this Storage in the file bytes
`ByteBuffer`	`getHeaderData()` return the existing header headerData for this storage
`boolean`	`getInitialized()`
`boolean`	`getIsSpecial()`
`String`	`getName()`
`int`	`getNextStorageID()` get the value of the nextProp variable
`int`	`getPrevStorageID()` get the value of the prevProp variable
`int`	`getSizeInBlocks()` get the number of Block records that this Storage needs to store its byte array
`int`	`getStartBlock()` get the starting block for the Storage headerData
`int`	`getStorageType()`
`void`	`init(List dta, int[] FAT, boolean keepStartBlock)` associate this storage with its blocks of data (obtained by walking down the FAT sector index chain to obtain blocks from the dta block store) for some bizarre reason, at idx 30208 the extraDIFAT jumps 5420 to 35628
`void`	`initFromMiniStream(List miniStream, int[] miniFAT)` Associate this storage with it's data (obtained by walking the miniFAT sector index to reference blocks in the miniStream
`void`	`setActualFileSize(int i)` set the size of the Storage headerData
`void`	`setBlocks(Block[] blks)`
`void`	`setBlockType(int type)` sets whether this Storage's headerData blocks are contained in the Small or Big Block arrays.
`void`	`setBytes(byte[] b)` set the underlying byte array for this Storage
`void`	`setBytesWithOverage(byte[] newbytes)` sets bytes for this storage; length of newbytes determines whether the storage is miniFAT or regular Incldes padding of bytes to ensure blocks are a factor of required block size
`void`	`setChildStorageID(int o)` set the value of the child storage id
`void`	`setDirectoryColor(int o)` set the value of the prevProp variable
`void`	`setInitialized(boolean b)`
`void`	`setIsSpecial(boolean b)`
`void`	`setName(String nm)` sets the storage name
`void`	`setNextStorageID(int o)` set the value of the nextProp variable
`void`	`setOutputBytes(OutputStream b, int blen)` set the underlying byte array for this Storage
`void`	`setPrevStorageID(int o)` set the value of the prevProp variable
`void`	`setStartBlock(int i)` set the starting block in the Block table array for this Storage's headerData.
`void`	`setStorageType(int i)` set the storage type
`String`	`toString()`
`void`	`writeBytes(OutputStream out)` return the underlying byte array for this Storage
`void`	`writeBytes(OutputStream out, int blen)` set the underlying byte array for this Storage

Methods inherited from class io.starter.formats.LEO.BlockByteReader
allocate, allocateDirect, array, arrayOffset, asCharBuffer, asDoubleBuffer, asFloatBuffer, asIntBuffer, asLongBuffer, asReadOnlyBuffer, asShortBuffer, capacity, clear, compact, duplicate, flip, get, get, get, get, get, getApplyRelativePosition, getBackingByteBuffer, getBlockmap, getChar, getChar, getDouble, getDouble, getFileOffsets, getFileOffsetString, getFloat, getFloat, getHeaderBytes, getInt, getInt, getLength, getLong, getLong, getReadPositions, getReadPositions, getShort, getShort, hasArray, hashCode, hasRemaining, isDirect, isReadOnly, limit, limit, mark, order, order, position, position, put, put, put, put, put, putChar, putChar, putDouble, putDouble, putFloat, putFloat, putInt, putInt, putLong, putLong, putShort, putShort, remaining, reset, rewind, setApplyRelativePosition, setBackingByteBuffer, setBlockmap, setLength, slice, wrap, wrap

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - storageType
```
public byte storageType
```
  - directoryColor
```
public byte directoryColor
```
  - prevStorageID
```
public int prevStorageID
```
  - nextStorageID
```
public int nextStorageID
```
  - childStorageID
```
public int childStorageID
```
  - sz
```
public int sz
```
  - miniStreamStorage
```
public boolean miniStreamStorage
```
  - myblocks
```
protected List myblocks
```
- Constructor Detail
  - Storage
```
protected Storage()
```
  - Storage
```
protected Storage(ByteBuffer buff)
```
    create a new Storage record with a byte array containing its record headerData.
- Method Detail
  - setBlocks
```
public void setBlocks(Block[] blks)
```
  - getBlockReader
```
public BlockByteReader getBlockReader()
```
    returns a new BlockByteReader
    
    Returns:
  - getBlockVect
```
public List getBlockVect()
```
  - setIsSpecial
```
public void setIsSpecial(boolean b)
```
  - getIsSpecial
```
public boolean getIsSpecial()
```
  - getInitialized
```
public boolean getInitialized()
```
  - setInitialized
```
public void setInitialized(boolean b)
```
  - setBlockType
```
public void setBlockType(int type)
```
    sets whether this Storage's headerData blocks are contained in the Small or Big Block arrays.
  - getBlockType
```
public int getBlockType()
```
    returns whether this Storage's headerData blocks are contained in the Small or Big Block arrays.
  - getStorageType
```
public int getStorageType()
```
  - getDirectoryColor
```
public int getDirectoryColor()
```
  - setDirectoryColor
```
public void setDirectoryColor(int o)
```
    set the value of the prevProp variable
  - getName
```
public String getName()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class BlockByteReader
  - setName
```
public void setName(String nm)
```
    sets the storage name
    
    Parameters:
    
    nm -
  - getPrevStorageID
```
public int getPrevStorageID()
```
    get the value of the prevProp variable
  - setPrevStorageID
```
public void setPrevStorageID(int o)
```
    set the value of the prevProp variable
  - getNextStorageID
```
public int getNextStorageID()
```
    get the value of the nextProp variable
  - setNextStorageID
```
public void setNextStorageID(int o)
```
    set the value of the nextProp variable
  - getChildStorageID
```
public int getChildStorageID()
```
    get the value of the child storage id
  - setChildStorageID
```
public void setChildStorageID(int o)
```
    set the value of the child storage id
  - getFilePos
```
public int getFilePos()
```
    get the position of this Storage in the file bytes
  - getHeaderData
```
public ByteBuffer getHeaderData()
```
    return the existing header headerData for this storage
  - getBytes
```
public byte[] getBytes()
```
    return the underlying byte array for this Storage
  - getByteStream
```
public OutputStream getByteStream()
```
    return the underlying byte array for this Storage
  - writeBytes
```
public void writeBytes(OutputStream out)
```
    return the underlying byte array for this Storage
  - writeBytes
```
public void writeBytes(OutputStream out,
                       int blen)
```
    set the underlying byte array for this Storage
  - setOutputBytes
```
public void setOutputBytes(OutputStream b,
                           int blen)
```
    set the underlying byte array for this Storage
  - setBytes
```
public void setBytes(byte[] b)
```
    set the underlying byte array for this Storage
  - setBytesWithOverage
```
public void setBytesWithOverage(byte[] newbytes)
```
    sets bytes for this storage; length of newbytes determines whether the storage is miniFAT or regular
    Incldes padding of bytes to ensure blocks are a factor of required block size
    
    Parameters:
    
    newbytes -
  - initFromMiniStream
```
public void initFromMiniStream(List miniStream,
                               int[] miniFAT)
                        throws LEOIndexingException
```
    Associate this storage with it's data (obtained by walking the miniFAT sector index to reference blocks in the miniStream
    
    Throws:
    
    LEOIndexingException
  - init
```
public void init(List dta,
                 int[] FAT,
                 boolean keepStartBlock)
```
    associate this storage with its blocks of data (obtained by walking down the FAT sector index chain to obtain blocks from the dta block store) for some bizarre reason, at idx 30208 the extraDIFAT jumps 5420 to 35628
  - addBlock
```
public void addBlock(Block b)
```
    adds a block of data to this storage
    
    Parameters:
    
    b -
  - setStorageType
```
public void setStorageType(int i)
```
    set the storage type
  - setActualFileSize
```
public void setActualFileSize(int i)
```
    set the size of the Storage headerData
  - getActualFileSize
```
public int getActualFileSize()
```
    get the size of the Storage headerData
  - setStartBlock
```
public void setStartBlock(int i)
```
    set the starting block in the Block table array for this Storage's headerData.
  - getStartBlock
```
public int getStartBlock()
```
    get the starting block for the Storage headerData
  - getSizeInBlocks
```
public int getSizeInBlocks()
```
    get the number of Block records that this Storage needs to store its byte array
  - addIdx
```
public void addIdx(int x)
```
    Track BB Index info
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class BlockByteReader
  - close
```
public void close()
```
    clear out object references in prep for closing workbook

Class Storage

Field Summary

Constructor Summary

Method Summary

Methods inherited from class io.starter.formats.LEO.BlockByteReader

Methods inherited from class java.lang.Object

Field Detail

storageType

directoryColor

prevStorageID

nextStorageID

childStorageID

sz

miniStreamStorage

myblocks

Constructor Detail

Storage

Storage

Method Detail

setBlocks

getBlockReader

getBlockVect

setIsSpecial

getIsSpecial

getInitialized

setInitialized

setBlockType

getBlockType

getStorageType

getDirectoryColor

setDirectoryColor

getName

toString

setName

getPrevStorageID

setPrevStorageID

getNextStorageID

setNextStorageID

getChildStorageID

setChildStorageID

getFilePos

getHeaderData

getBytes

getByteStream

writeBytes

writeBytes

setOutputBytes

setBytes

setBytesWithOverage

initFromMiniStream

init

addBlock

setStorageType

setActualFileSize

getActualFileSize

setStartBlock

getStartBlock

getSizeInBlocks

addIdx

equals

close