Package loci.poi.ddf

Class EscherProperty

java.lang.Object
loci.poi.ddf.EscherProperty
Direct Known Subclasses:
EscherComplexProperty, EscherSimpleProperty

public abstract class EscherProperty extends Object
This is the abstract base class for all escher properties.
Author:
Glen Stampoultzis (glens at apache.org)
See Also:
  • Field Details

    • id

      protected short id
  • Constructor Details

    • EscherProperty

      public EscherProperty(short id)
      The id is distinct from the actual property number. The id includes the property number the blip id flag and an indicator whether the property is complex or not.
    • EscherProperty

      public EscherProperty(short propertyNumber, boolean isComplex, boolean isBlipId)
      Constructs a new escher property. The three parameters are combined to form a property id.
  • Method Details

    • getId

      public short getId()
    • getPropertyNumber

      public short getPropertyNumber()
    • isComplex

      public boolean isComplex()
    • isBlipId

      public boolean isBlipId()
    • getName

      public String getName()
    • getPropertySize

      public int getPropertySize()
      Most properties are just 6 bytes in length. Override this if we're dealing with complex properties.
    • serializeSimplePart

      public abstract int serializeSimplePart(byte[] data, int pos)
      Escher properties consist of a simple fixed length part and a complex variable length part. The fixed length part is serialized first.
    • serializeComplexPart

      public abstract int serializeComplexPart(byte[] data, int pos)
      Escher properties consist of a simple fixed length part and a complex variable length part. The fixed length part is serialized first.