Save This Page
Home » poi-src-3.2-FINAL-20081019 » org.apache.poi.poifs » property » [javadoc | source]
org.apache.poi.poifs.property
abstract public class: Property [javadoc | source]
java.lang.Object
   org.apache.poi.poifs.property.Property

All Implemented Interfaces:
    POIFSViewable, Child

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

This abstract base class is the ancestor of all classes implementing POIFS Property behavior.
Field Summary
protected static final  int _NO_INDEX     
protected static final  byte _NODE_BLACK     
protected static final  byte _NODE_RED     
Constructor:
 protected Property() 
 protected Property(int index,
    byte[] array,
    int offset) 
Method from org.apache.poi.poifs.property.Property Summary:
getChildIndex,   getIndex,   getName,   getNextChild,   getNextChildIndex,   getPreviousChild,   getPreviousChildIndex,   getShortDescription,   getSize,   getStartBlock,   getStorageClsid,   getViewableArray,   getViewableIterator,   isDirectory,   isSmall,   isValidIndex,   preWrite,   preferArray,   setChildProperty,   setIndex,   setName,   setNextChild,   setNodeColor,   setPreviousChild,   setPropertyType,   setSize,   setStartBlock,   setStorageClsid,   shouldUseSmallBlocks,   writeData
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.poi.poifs.property.Property Detail:
 protected int getChildIndex() 
    Get the child property (its index in the Property Table)
 protected int getIndex() 
    get the index for this Property
 public String getName() 
    Get the name of this property
 public Child getNextChild() 
    Get the next Child, if any
 int getNextChildIndex() 
    get the next sibling
 public Child getPreviousChild() 
    Get the previous Child, if any
 int getPreviousChildIndex() 
    get the previous sibling
 public String getShortDescription() 
    Provides a short description of the object, to be used when a POIFSViewable object has not provided its contents.
 public int getSize() 
    find out the document size
 public int getStartBlock() 
 public ClassID getStorageClsid() 
    Sets the storage clsid, which is the Class ID of a COM object which reads and writes this stream
 public Object[] getViewableArray() 
    Get an array of objects, some of which may implement POIFSViewable
 public Iterator getViewableIterator() 
    Get an Iterator of objects, some of which may implement POIFSViewable
 abstract public boolean isDirectory()
 public static boolean isSmall(int length) 
    does the length indicate a small document?
 static boolean isValidIndex(int index) 
    determine whether the specified index is valid
 abstract protected  void preWrite()
    Perform whatever activities need to be performed prior to writing
 public boolean preferArray() 
    Give viewers a hint as to whether to call getViewableArray or getViewableIterator
 protected  void setChildProperty(int child) 
    Set the child property.
 protected  void setIndex(int index) 
    Set the index for this Property
 protected final  void setName(String name) 
    Set the name; silently truncates the name if it's too long.
 public  void setNextChild(Child child) 
    Set the next Child
 protected  void setNodeColor(byte nodeColor) 
    Set the node color.
 public  void setPreviousChild(Child child) 
    Set the previous Child
 protected  void setPropertyType(byte propertyType) 
    Set the property type. Makes no attempt to validate the value.
 protected  void setSize(int size) 
    Set the size of the document associated with this Property
 public  void setStartBlock(int startBlock) 
    Set the start block for the document referred to by this Property.
 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
 public boolean shouldUseSmallBlocks() 
    Based on the currently defined size, should this property use small blocks?
 public  void writeData(OutputStream stream) throws IOException 
    Write the raw data to an OutputStream.