/* ====================================================================
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You under the Apache License, Version 2.0
   (the "License"); you may not use this file except in compliance with
   the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
==================================================================== */

package org.apache.poi.ddf;

This is the abstract base class for all escher properties.
See Also:
EscherOptRecord/**
 * This is the abstract base class for all escher properties.
 *
 * @see EscherOptRecord
 */
public abstract class EscherProperty {
    private 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.
Params:
id – the combined 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.
     * 
     * @param id the combined id
     */
    public EscherProperty(short id) {
        _id   = id;
    }

    
Constructs a new escher property.  The three parameters are combined to form a property
id.
Params:
propertyNumber – the property number
isComplex – true, if this is a complex property
isBlipId – true, if this property is a blip id/**
     * Constructs a new escher property.  The three parameters are combined to form a property
     * id.
     * 
     * @param propertyNumber the property number
     * @param isComplex true, if this is a complex property
     * @param isBlipId true, if this property is a blip id
     */
    public EscherProperty(short propertyNumber, boolean isComplex, boolean isBlipId) {
        _id   = (short)(propertyNumber +
                (isComplex ? 0x8000 : 0x0) +
                (isBlipId ? 0x4000 : 0x0));
    }

    public short getId() {
        return _id;
    }

    public short getPropertyNumber() {
        return (short) (_id & (short) 0x3FFF);
    }

    public boolean isComplex() {
        return (_id & (short) 0x8000) != 0;
    }

    public boolean isBlipId() {
        return (_id & (short) 0x4000) != 0;
    }

    public String getName() {
        return EscherProperties.getPropertyName(getPropertyNumber());
    }

    
Most properties are just 6 bytes in length.  Override this if we're
dealing with complex properties.
Returns:
size of this property (in bytes)/**
     * Most properties are just 6 bytes in length.  Override this if we're
     * dealing with complex properties.
     * 
     * @return size of this property (in bytes)
     */
    public int getPropertySize() {
        return 6;
    }
    
    public String toXml(String tab){
        StringBuilder builder = new StringBuilder();
        builder.append(tab).append("<").append(getClass().getSimpleName()).append(" id=\"").append(getId()).append("\" name=\"").append(getName()).append("\" blipId=\"")
                .append(isBlipId()).append("\"/>\n");
        return builder.toString();
    }

    
Escher properties consist of a simple fixed length part and a complex variable length part.
The fixed length part is serialized first.
Params:
data – the buffer to write to
pos – the starting position
Returns:
the length of the part/**
     * Escher properties consist of a simple fixed length part and a complex variable length part.
     * The fixed length part is serialized first.
     * 
     * @param data the buffer to write to
     * @param pos the starting position
     * 
     * @return the length of the part
     */
    abstract public 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.
Params:
data – the buffer to write to
pos – the starting position
Returns:
the length of the part/**
     * Escher properties consist of a simple fixed length part and a complex variable length part.
     * The fixed length part is serialized first.
     * 
     * @param data the buffer to write to
     * @param pos the starting position
     * 
     * @return the length of the part
     */
    abstract public int serializeComplexPart( byte[] data, int pos );


    @Override
    abstract public String toString();
}