Property (Bio-Formats API)

java.lang.Object
- loci.poi.poifs.property.Property

All Implemented Interfaces:

POIFSViewable, Child

Direct Known Subclasses:

DirectoryProperty, DocumentProperty
```
public abstract class Property
extends Object
implements Child, POIFSViewable
```
This abstract base class is the ancestor of all classes implementing POIFS Property behavior.

Author:

Marc Johnson (mjohnson at apache dot org)

Field Summary

Fields
Modifier and Type	Field and Description
`private static int`	`_big_block_minimum_bytes`
`private IntegerField`	`_child_property`
`private static int`	`_child_property_offset`
`private IntegerField`	`_days_1`
`private static int`	`_days_1_offset`
`private IntegerField`	`_days_2`
`private static int`	`_days_2_offset`
`private static byte`	`_default_fill`
`private int`	`_index`
`private static int`	`_max_name_length`
`private String`	`_name`
`private ShortField`	`_name_size`
`private static int`	`_name_size_offset`
`private Child`	`_next_child`
`private IntegerField`	`_next_property`
`private static int`	`_next_property_offset`
`protected static int`	`_NO_INDEX`
`protected static byte`	`_NODE_BLACK`
`private ByteField`	`_node_color`
`private static int`	`_node_color_offset`
`protected static byte`	`_NODE_RED`
`private Child`	`_previous_child`
`private IntegerField`	`_previous_property`
`private static int`	`_previous_property_offset`
`private ByteField`	`_property_type`
`private byte[]`	`_raw_data`
`private IntegerField`	`_seconds_1`
`private static int`	`_seconds_1_offset`
`private IntegerField`	`_seconds_2`
`private static int`	`_seconds_2_offset`
`private IntegerField`	`_size`
`private static int`	`_size_offset`
`private IntegerField`	`_start_block`
`private static int`	`_start_block_offset`
`private ClassID`	`_storage_clsid`
`private static int`	`_storage_clsid_offset`
`private IntegerField`	`_user_flags`
`private static int`	`_user_flags_offset`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Property()` Default constructor
`protected`	`Property(int index, byte[] array, int offset)` Constructor from byte data

Method Summary

Methods
Modifier and Type	Method and Description
`protected int`	`getChildIndex()` Get the child property (its index in the Property Table)
`protected int`	`getIndex()` get the index for this Property
`String`	`getName()` Get the name of this property
`Child`	`getNextChild()` Get the next Child, if any
`(package private) int`	`getNextChildIndex()` get the next sibling
`Child`	`getPreviousChild()` Get the previous Child, if any
`(package private) int`	`getPreviousChildIndex()` get the previous sibling
`String`	`getShortDescription()` Provides a short description of the object, to be used when a POIFSViewable object has not provided its contents.
`int`	`getSize()` find out the document size
`int`	`getStartBlock()`
`ClassID`	`getStorageClsid()` Sets the storage clsid, which is the Class ID of a COM object which reads and writes this stream
`Object[]`	`getViewableArray()` Get an array of objects, some of which may implement POIFSViewable
`Iterator`	`getViewableIterator()` Get an Iterator of objects, some of which may implement POIFSViewable
`abstract boolean`	`isDirectory()`
`static boolean`	`isSmall(int length)` does the length indicate a small document?
`(package private) static boolean`	`isValidIndex(int index)` determine whether the specified index is valid
`boolean`	`preferArray()` Give viewers a hint as to whether to call getViewableArray or getViewableIterator
`protected abstract void`	`preWrite()` Perform whatever activities need to be performed prior to writing
`protected void`	`setChildProperty(int child)` Set the child property.
`protected void`	`setIndex(int index)` Set the index for this Property
`protected void`	`setName(String name)` Set the name; silently truncates the name if it's too long.
`void`	`setNextChild(Child child)` Set the next Child
`protected void`	`setNodeColor(byte nodeColor)` Set the node color.
`void`	`setPreviousChild(Child child)` Set the previous Child
`protected void`	`setPropertyType(byte propertyType)` Set the property type.
`protected void`	`setSize(int size)` Set the size of the document associated with this Property
`void`	`setStartBlock(int startBlock)` Set the start block for the document referred to by this Property.
`void`	`setStorageClsid(ClassID clsidStorage)` Sets the storage class ID for this property stream.
`boolean`	`shouldUseSmallBlocks()` Based on the currently defined size, should this property use small blocks?
`void`	`writeData(OutputStream stream)` Write the raw data to an OutputStream.

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

- Field Detail
  - _default_fill
```
private static final byte _default_fill
```
    See Also:
    Constant Field Values
  - _name_size_offset
```
private static final int _name_size_offset
```
    See Also:
    Constant Field Values
  - _max_name_length
```
private static final int _max_name_length
```
    See Also:
    Constant Field Values
  - _NO_INDEX
```
protected static final int _NO_INDEX
```
    See Also:
    Constant Field Values
  - _node_color_offset
```
private static final int _node_color_offset
```
    See Also:
    Constant Field Values
  - _previous_property_offset
```
private static final int _previous_property_offset
```
    See Also:
    Constant Field Values
  - _next_property_offset
```
private static final int _next_property_offset
```
    See Also:
    Constant Field Values
  - _child_property_offset
```
private static final int _child_property_offset
```
    See Also:
    Constant Field Values
  - _storage_clsid_offset
```
private static final int _storage_clsid_offset
```
    See Also:
    Constant Field Values
  - _user_flags_offset
```
private static final int _user_flags_offset
```
    See Also:
    Constant Field Values
  - _seconds_1_offset
```
private static final int _seconds_1_offset
```
    See Also:
    Constant Field Values
  - _days_1_offset
```
private static final int _days_1_offset
```
    See Also:
    Constant Field Values
  - _seconds_2_offset
```
private static final int _seconds_2_offset
```
    See Also:
    Constant Field Values
  - _days_2_offset
```
private static final int _days_2_offset
```
    See Also:
    Constant Field Values
  - _start_block_offset
```
private static final int _start_block_offset
```
    See Also:
    Constant Field Values
  - _size_offset
```
private static final int _size_offset
```
    See Also:
    Constant Field Values
  - _NODE_BLACK
```
protected static final byte _NODE_BLACK
```
    See Also:
    Constant Field Values
  - _NODE_RED
```
protected static final byte _NODE_RED
```
    See Also:
    Constant Field Values
  - _big_block_minimum_bytes
```
private static final int _big_block_minimum_bytes
```
    See Also:
    Constant Field Values
  - _name
```
private String _name
```
  - _name_size
```
private ShortField _name_size
```
  - _property_type
```
private ByteField _property_type
```
  - _node_color
```
private ByteField _node_color
```
  - _previous_property
```
private IntegerField _previous_property
```
  - _next_property
```
private IntegerField _next_property
```
  - _child_property
```
private IntegerField _child_property
```
  - _storage_clsid
```
private ClassID _storage_clsid
```
  - _user_flags
```
private IntegerField _user_flags
```
  - _seconds_1
```
private IntegerField _seconds_1
```
  - _days_1
```
private IntegerField _days_1
```
  - _seconds_2
```
private IntegerField _seconds_2
```
  - _days_2
```
private IntegerField _days_2
```
  - _start_block
```
private IntegerField _start_block
```
  - _size
```
private IntegerField _size
```
  - _raw_data
```
private byte[] _raw_data
```
  - _index
```
private int _index
```
  - _next_child
```
private Child _next_child
```
  - _previous_child
```
private Child _previous_child
```
- Constructor Detail
  - Property
```
protected Property()
```
    Default constructor
  - Property
```
protected Property(int index,
        byte[] array,
        int offset)
```
    Constructor from byte data
    
    Parameters:
    index - index number
    array - byte data
    offset - offset into byte data
- Method Detail
  - writeData
```
public void writeData(OutputStream stream)
               throws IOException
```
    Write the raw data to an OutputStream.
    
    Parameters:
    stream - the OutputStream to which the data should be written.
    
    Throws:
    
    IOException - on problems writing to the specified stream.
  - setStartBlock
```
public void setStartBlock(int startBlock)
```
    Set the start block for the document referred to by this Property.
    
    Parameters:
    startBlock - the start block index
  - getStartBlock
```
public int getStartBlock()
```
    Returns:
    the start block
  - getSize
```
public int getSize()
```
    find out the document size
    
    Returns:
    size in bytes
  - shouldUseSmallBlocks
```
public boolean shouldUseSmallBlocks()
```
    Based on the currently defined size, should this property use small blocks?
    
    Returns:
    true if the size is less than _big_block_minimum_bytes
  - isSmall
```
public static boolean isSmall(int length)
```
    does the length indicate a small document?
    
    Parameters:
    length - length in bytes
    
    Returns:
    true if the length is less than _big_block_minimum_bytes
  - getName
```
public String getName()
```
    Get the name of this property
    
    Returns:
    property name as String
  - isDirectory
```
public abstract boolean isDirectory()
```
    Returns:
    true if a directory type Property
  - getStorageClsid
```
public ClassID getStorageClsid()
```
    Sets the storage clsid, which is the Class ID of a COM object which reads and writes this stream
    
    Returns:
    storage Class ID for this property stream
  - setName
```
protected final void setName(String name)
```
    Set the name; silently truncates the name if it's too long.
    
    Parameters:
    name - the new name
  - setStorageClsid
```
public void setStorageClsid(ClassID clsidStorage)
```
    Sets the storage class ID for this property stream. This is the Class ID of the COM object which can read and write this property stream
    
    Parameters:
    clsidStorage - Storage Class ID
  - setPropertyType
```
protected void setPropertyType(byte propertyType)
```
    Set the property type. Makes no attempt to validate the value.
    
    Parameters:
    propertyType - the property type (root, file, directory)
  - setNodeColor
```
protected void setNodeColor(byte nodeColor)
```
    Set the node color.
    
    Parameters:
    nodeColor - the node color (red or black)
  - setChildProperty
```
protected void setChildProperty(int child)
```
    Set the child property.
    
    Parameters:
    child - the child property's index in the Property Table
  - getChildIndex
```
protected int getChildIndex()
```
    Get the child property (its index in the Property Table)
    
    Returns:
    child property index
  - setSize
```
protected void setSize(int size)
```
    Set the size of the document associated with this Property
    
    Parameters:
    size - the size of the document, in bytes
  - setIndex
```
protected void setIndex(int index)
```
    Set the index for this Property
    
    Parameters:
    index - this Property's index within its containing Property Table
  - getIndex
```
protected int getIndex()
```
    get the index for this Property
    
    Returns:
    the index of this Property within its Property Table
  - preWrite
```
protected abstract void preWrite()
```
    Perform whatever activities need to be performed prior to writing
  - getNextChildIndex
```
int getNextChildIndex()
```
    get the next sibling
    
    Returns:
    index of next sibling
  - getPreviousChildIndex
```
int getPreviousChildIndex()
```
    get the previous sibling
    
    Returns:
    index of previous sibling
  - isValidIndex
```
static boolean isValidIndex(int index)
```
    determine whether the specified index is valid
    
    Parameters:
    index - value to be checked
    
    Returns:
    true if the index is valid
  - getNextChild
```
public Child getNextChild()
```
    Get the next Child, if any
    
    Specified by:
    
    getNextChild in interface Child
    
    Returns:
    the next Child; may return null
  - getPreviousChild
```
public Child getPreviousChild()
```
    Get the previous Child, if any
    
    Specified by:
    
    getPreviousChild in interface Child
    
    Returns:
    the previous Child; may return null
  - setNextChild
```
public void setNextChild(Child child)
```
    Set the next Child
    
    Specified by:
    
    setNextChild in interface Child
    
    Parameters:
    child - the new 'next' child; may be null, which has the effect of saying there is no 'next' child
  - setPreviousChild
```
public void setPreviousChild(Child child)
```
    Set the previous Child
    
    Specified by:
    
    setPreviousChild in interface Child
    
    Parameters:
    child - the new 'previous' child; may be null, which has the effect of saying there is no 'previous' child
  - getViewableArray
```
public Object[] getViewableArray()
```
    Get an array of objects, some of which may implement POIFSViewable
    
    Specified by:
    
    getViewableArray in interface POIFSViewable
    
    Returns:
    an array of Object; may not be null, but may be empty
  - getViewableIterator
```
public Iterator getViewableIterator()
```
    Get an Iterator of objects, some of which may implement POIFSViewable
    
    Specified by:
    
    getViewableIterator in interface POIFSViewable
    
    Returns:
    an Iterator; may not be null, but may have an empty back end store
  - preferArray
```
public boolean preferArray()
```
    Give viewers a hint as to whether to call getViewableArray or getViewableIterator
    
    Specified by:
    
    preferArray in interface POIFSViewable
    
    Returns:
    true if a viewer should call getViewableArray, false if a viewer should call getViewableIterator
  - getShortDescription
```
public String getShortDescription()
```
    Provides a short description of the object, to be used when a POIFSViewable object has not provided its contents.
    
    Specified by:
    
    getShortDescription in interface POIFSViewable
    
    Returns:
    short description

Class Property

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_default_fill

_name_size_offset

_max_name_length

_NO_INDEX

_node_color_offset

_previous_property_offset

_next_property_offset

_child_property_offset

_storage_clsid_offset

_user_flags_offset

_seconds_1_offset

_days_1_offset

_seconds_2_offset

_days_2_offset

_start_block_offset

_size_offset

_NODE_BLACK

_NODE_RED

_big_block_minimum_bytes

_name

_name_size

_property_type

_node_color

_previous_property

_next_property

_child_property

_storage_clsid

_user_flags

_seconds_1

_days_1

_seconds_2

_days_2

_start_block

_size

_raw_data

_index

_next_child

_previous_child

Constructor Detail

Property

Property

Method Detail

writeData

setStartBlock

getStartBlock

getSize

shouldUseSmallBlocks

isSmall

getName

isDirectory

getStorageClsid

setName

setStorageClsid

setPropertyType

setNodeColor

setChildProperty

getChildIndex

setSize

setIndex

getIndex

preWrite

getNextChildIndex

getPreviousChildIndex

isValidIndex

getNextChild

getPreviousChild

setNextChild

setPreviousChild

getViewableArray

getViewableIterator

preferArray

getShortDescription