org.apache.cocoon.poi.poifs.property: abstract public class: Property

org.apache.cocoon.poi.poifs.property
abstract public class: Property [javadoc | source]

java.lang.Object
   org.apache.cocoon.poi.poifs.property.Property

All Implemented Interfaces:
File

Direct Known Subclasses:
RootProperty, DocumentProperty, LocalProperty, DirectoryProperty, LocalProperty

This abstract base class is the ancestor of all classes implementing POIFS Property behavior.

author: Marc - Johnson (marc_johnson27591@hotmail.com)

Field Summary
protected static final int	_NO_INDEX
static final int	_property_type_offset
static final byte	_DIRECTORY_TYPE
static final byte	_DOCUMENT_TYPE
static final byte	_ROOT_TYPE
protected static final byte	_NODE_BLACK
protected static final byte	_NODE_RED

Constructor:

Constructor:
protected Property() { _raw_data = new byte[ PoiFSConstants.PROPERTY_SIZE ]; Arrays.fill(_raw_data, _default_fill); _name_size = new ShortField(_name_size_offset); _property_type = new ByteField(_property_type_offset); _node_color = new ByteField(_node_color_offset); _previous_property = new IntegerField(_previous_property_offset, _NO_INDEX, _raw_data); _next_property = new IntegerField(_next_property_offset, _NO_INDEX, _raw_data); _child_property = new IntegerField(_child_property_offset, _NO_INDEX, _raw_data); _seconds_1 = new IntegerField(_seconds_1_offset, 0, _raw_data); _days_1 = new IntegerField(_days_1_offset, 0, _raw_data); _seconds_2 = new IntegerField(_seconds_2_offset, 0, _raw_data); _days_2 = new IntegerField(_days_2_offset, 0, _raw_data); _start_block = new IntegerField(_start_block_offset); _size = new IntegerField(_size_offset, 0, _raw_data); _index = _NO_INDEX; setName(""); setNextFile(null); setPreviousFile(null); } Default constructor
protected Property(int index, byte[] array, int offset) { _raw_data = new byte[ PoiFSConstants.PROPERTY_SIZE ]; System.arraycopy(array, offset, _raw_data, 0, PoiFSConstants.PROPERTY_SIZE); _name_size = new ShortField(_name_size_offset, _raw_data); _property_type = new ByteField(_property_type_offset, _raw_data); _node_color = new ByteField(_node_color_offset, _raw_data); _previous_property = new IntegerField(_previous_property_offset, _raw_data); _next_property = new IntegerField(_next_property_offset, _raw_data); _child_property = new IntegerField(_child_property_offset, _raw_data); _seconds_1 = new IntegerField(_seconds_1_offset, _raw_data); _days_1 = new IntegerField(_days_1_offset, _raw_data); _seconds_2 = new IntegerField(_seconds_2_offset, _raw_data); _days_2 = new IntegerField(_days_2_offset, _raw_data); _start_block = new IntegerField(_start_block_offset, _raw_data); _size = new IntegerField(_size_offset, _raw_data); _index = index; int name_length = (_name_size.get() / LittleEndianConsts.SHORT_SIZE) - 1; if (name_length < 1) { _name = ""; } else { char[] char_array = new char[ name_length ]; int name_offset = 0; for (int j = 0; j < name_length; j++) { char_array[ j ] = ( char ) new ShortField(name_offset, _raw_data).get(); name_offset += LittleEndianConsts.SHORT_SIZE; } _name = new String(char_array, 0, name_length); } _next_file = null; _previous_file = null; } Constructor from byte data Parameters: `index` - index number `array` - byte data `offset` - offset into byte data

 protected Property() {
           
        _raw_data = new byte[ PoiFSConstants.PROPERTY_SIZE ];
        Arrays.fill(_raw_data, _default_fill);
        _name_size         = new ShortField(_name_size_offset);
        _property_type     = new ByteField(_property_type_offset);
        _node_color        = new ByteField(_node_color_offset);
        _previous_property = new IntegerField(_previous_property_offset,
                                              _NO_INDEX, _raw_data);
        _next_property     = new IntegerField(_next_property_offset,
                                              _NO_INDEX, _raw_data);
        _child_property    = new IntegerField(_child_property_offset,
                                              _NO_INDEX, _raw_data);
        _seconds_1         = new IntegerField(_seconds_1_offset, 0,
                                              _raw_data);
        _days_1            = new IntegerField(_days_1_offset, 0, _raw_data);
        _seconds_2         = new IntegerField(_seconds_2_offset, 0,
                                              _raw_data);
        _days_2            = new IntegerField(_days_2_offset, 0, _raw_data);
        _start_block       = new IntegerField(_start_block_offset);
        _size              = new IntegerField(_size_offset, 0, _raw_data);
        _index             = _NO_INDEX;
        setName("");
        setNextFile(null);
        setPreviousFile(null);
}

Default constructor

 protected Property(int index,
    byte[] array,
    int offset) {
        _raw_data = new byte[ PoiFSConstants.PROPERTY_SIZE ];
        System.arraycopy(array, offset, _raw_data, 0,
                         PoiFSConstants.PROPERTY_SIZE);
        _name_size         = new ShortField(_name_size_offset, _raw_data);
        _property_type     = new ByteField(_property_type_offset, _raw_data);
        _node_color        = new ByteField(_node_color_offset, _raw_data);
        _previous_property = new IntegerField(_previous_property_offset,
                                              _raw_data);
        _next_property     = new IntegerField(_next_property_offset,
                                              _raw_data);
        _child_property    = new IntegerField(_child_property_offset,
                                              _raw_data);
        _seconds_1         = new IntegerField(_seconds_1_offset, _raw_data);
        _days_1            = new IntegerField(_days_1_offset, _raw_data);
        _seconds_2         = new IntegerField(_seconds_2_offset, _raw_data);
        _days_2            = new IntegerField(_days_2_offset, _raw_data);
        _start_block       = new IntegerField(_start_block_offset, _raw_data);
        _size              = new IntegerField(_size_offset, _raw_data);
        _index             = index;
        int name_length = (_name_size.get() / LittleEndianConsts.SHORT_SIZE)
                          - 1;
        if (name_length <  1)
        {
            _name = "";
        }
        else
        {
            char[] char_array  = new char[ name_length ];
            int    name_offset = 0;
            for (int j = 0; j <  name_length; j++)
            {
                char_array[ j ] = ( char ) new ShortField(name_offset,
                                                          _raw_data).get();
                name_offset     += LittleEndianConsts.SHORT_SIZE;
            }
            _name = new String(char_array, 0, name_length);
        }
        _next_file     = null;
        _previous_file = null;
}

Constructor from byte data

Parameters:

index - index number

array - byte data

offset - offset into byte data

Method from org.apache.cocoon.poi.poifs.property.Property Summary:
getChildIndex, getIndex, getName, getNextChildIndex, getNextFile, getPreviousChildIndex, getPreviousFile, getSize, getStartBlock, isDirectory, isSmall, isValidIndex, preWrite, setChildProperty, setIndex, setName, setNextFile, setNodeColor, setPreviousFile, setPropertyType, setSize, setStartBlock, shouldUseSmallBlocks, writeData

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.apache.cocoon.poi.poifs.property.Property Detail:
protected int getChildIndex() { return _child_property.get(); } Get the child property (its index in the Property Table)
protected int getIndex() { return _index; } get the index for this Property
public String getName() { return _name; } Get the name of this property
int getNextChildIndex() { return _next_property.get(); } get the next sibling
public File getNextFile() { return _next_file; } Get the next File, if any
int getPreviousChildIndex() { return _previous_property.get(); } get the previous sibling
public File getPreviousFile() { return _previous_file; } Get the previous File, if any
public int getSize() { return _size.get(); } find out the document size
public int getStartBlock() { return _start_block.get(); }
abstract public boolean isDirectory()
public static boolean isSmall(int length) { return length < _big_block_minimum_bytes; } does the length indicate a small document?
static boolean isValidIndex(int index) { return index != _NO_INDEX; } determine whether the specified index is valid
abstract protected void preWrite() Perform whatever activities need to be performed prior to writing
protected void setChildProperty(int child) { _child_property.set(child, _raw_data); } Set the child property.
protected void setIndex(int index) { _index = index; } Set the index for this Property
protected final void setName(String name) { char[] char_array = name.toCharArray(); int limit = Math.min(char_array.length, _max_name_length); _name = new String(char_array, 0, limit); short offset = 0; int j = 0; for (; j < limit; j++) { new ShortField(offset, ( short ) char_array[ j ], _raw_data); offset += LittleEndianConsts.SHORT_SIZE; } for (; j < _max_name_length + 1; j++) { new ShortField(offset, ( short ) 0, _raw_data); offset += LittleEndianConsts.SHORT_SIZE; } // double the count, and include the null at the end _name_size .set(( short ) ((limit + 1) * LittleEndianConsts.SHORT_SIZE), _raw_data); } Set the name; silently truncates the name if it's too long.
public void setNextFile(File file) { _next_file = file; _next_property.set((file == null) ? _NO_INDEX : (( Property ) file) .getIndex(), _raw_data); } Set the next File
protected void setNodeColor(byte nodeColor) { _node_color.set(nodeColor, _raw_data); } Set the node color.
public void setPreviousFile(File file) { _previous_file = file; _previous_property.set((file == null) ? _NO_INDEX : (( Property ) file) .getIndex(), _raw_data); } Set the previous File
protected void setPropertyType(byte propertyType) { _property_type.set(propertyType, _raw_data); } Set the property type. Makes no attempt to validate the value.
protected void setSize(int size) { _size.set(size, _raw_data); } Set the size of the document associated with this Property
public void setStartBlock(int startBlock) { _start_block.set(startBlock, _raw_data); } Set the start block for the document referred to by this Property.
public boolean shouldUseSmallBlocks() { return Property.isSmall(_size.get()); } Based on the currently defined size, should this property use small blocks?
public void writeData(OutputStream stream) throws IOException { stream.write(_raw_data); } Write the raw data to an OutputStream.

Method from org.apache.cocoon.poi.poifs.property.Property Detail:

 protected int getChildIndex() {
        return _child_property.get();
}

Get the child property (its index in the Property Table)

 protected int getIndex() {
        return _index;
}

get the index for this Property

 public String getName() {
        return _name;
}

Get the name of this property

 int getNextChildIndex() {
        return _next_property.get();
}

get the next sibling

 public File getNextFile() {
        return _next_file;
}

Get the next File, if any

 int getPreviousChildIndex() {
        return _previous_property.get();
}

get the previous sibling

 public File getPreviousFile() {
        return _previous_file;
}

Get the previous File, if any

 public int getSize() {
        return _size.get();
}

find out the document size

 public int getStartBlock() {
        return _start_block.get();
}

 abstract public boolean isDirectory()

 public static boolean isSmall(int length) {
        return length <  _big_block_minimum_bytes;
}

does the length indicate a small document?

 static boolean isValidIndex(int index) {
        return index != _NO_INDEX;
}

determine whether the specified index is valid

 abstract protected  void preWrite()Perform whatever activities need to be performed prior to
writing

 protected  void setChildProperty(int child) {
        _child_property.set(child, _raw_data);
}

Set the child property.

 protected  void setIndex(int index) {
        _index = index;
}

Set the index for this Property

 protected final  void setName(String name) {
        char[] char_array = name.toCharArray();
        int    limit      = Math.min(char_array.length, _max_name_length);
        _name = new String(char_array, 0, limit);
        short offset = 0;
        int   j      = 0;
        for (; j <  limit; j++)
        {
            new ShortField(offset, ( short ) char_array[ j ], _raw_data);
            offset += LittleEndianConsts.SHORT_SIZE;
        }
        for (; j <  _max_name_length + 1; j++)
        {
            new ShortField(offset, ( short ) 0, _raw_data);
            offset += LittleEndianConsts.SHORT_SIZE;
        }
        // double the count, and include the null at the end
        _name_size
            .set(( short ) ((limit + 1)
                            * LittleEndianConsts.SHORT_SIZE), _raw_data);
}

Set the name; silently truncates the name if it's too long.

 public  void setNextFile(File file) {
        _next_file = file;
        _next_property.set((file == null) ? _NO_INDEX
                                          : (( Property ) file)
                                              .getIndex(), _raw_data);
}

Set the next File

 protected  void setNodeColor(byte nodeColor) {
        _node_color.set(nodeColor, _raw_data);
}

Set the node color.

 public  void setPreviousFile(File file) {
        _previous_file = file;
        _previous_property.set((file == null) ? _NO_INDEX
                                              : (( Property ) file)
                                                  .getIndex(), _raw_data);
}

Set the previous File

 protected  void setPropertyType(byte propertyType) {
        _property_type.set(propertyType, _raw_data);
}

Set the property type. Makes no attempt to validate the value.

 protected  void setSize(int size) {
        _size.set(size, _raw_data);
}

Set the size of the document associated with this Property

 public  void setStartBlock(int startBlock) {
        _start_block.set(startBlock, _raw_data);
}

Set the start block for the document referred to by this Property.

 public boolean shouldUseSmallBlocks() {
        return Property.isSmall(_size.get());
}

Based on the currently defined size, should this property use small blocks?

 public  void writeData(OutputStream stream) throws IOException {
        stream.write(_raw_data);
}

Write the raw data to an OutputStream.