/*
 * 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.
 */

/* $Id: AbstractTripletStructuredObject.java 1694450 2015-08-06 10:59:51Z ssteiner $ */

package org.apache.fop.afp.modca;

import java.io.IOException;
import java.io.OutputStream;
import java.util.Collection;
import java.util.List;

import org.apache.fop.afp.modca.Registry.ObjectType;
import org.apache.fop.afp.modca.triplets.AbstractTriplet;
import org.apache.fop.afp.modca.triplets.CommentTriplet;
import org.apache.fop.afp.modca.triplets.FullyQualifiedNameTriplet;
import org.apache.fop.afp.modca.triplets.ObjectClassificationTriplet;
import org.apache.fop.afp.modca.triplets.Triplet;

A MODCA structured object base class providing support for Triplets
/**
 * A MODCA structured object base class providing support for Triplets
 */
public abstract class AbstractTripletStructuredObject extends AbstractStructuredObject {

    
list of object triplets /** list of object triplets */
    protected List<AbstractTriplet> triplets = new java.util.ArrayList<AbstractTriplet>();

    
Returns the triplet data length
Returns:
the triplet data length/**
     * Returns the triplet data length
     *
     * @return the triplet data length
     */
    protected int getTripletDataLength() {
        int dataLength = 0;
        for (Triplet triplet : triplets) {
            dataLength += triplet.getDataLength();
        }
        return dataLength;
    }

    
Returns true when this structured field contains triplets
Returns:
true when this structured field contains triplets/**
     * Returns true when this structured field contains triplets
     *
     * @return true when this structured field contains triplets
     */
    public boolean hasTriplets() {
        return triplets.size() > 0;
    }

    
Writes any triplet data
Params:
os – The stream to write to
Throws:
IOException – The stream to write to/**
     * Writes any triplet data
     *
     * @param os The stream to write to
     * @throws IOException The stream to write to
     */
    protected void writeTriplets(OutputStream os) throws IOException {
        if (hasTriplets()) {
            writeObjects(triplets, os);
            triplets = null; // gc
        }
    }

    
Returns the first matching triplet found in the structured field triplet list
Params:
tripletId – the triplet identifier/**
     * Returns the first matching triplet found in the structured field triplet list
     *
     * @param tripletId the triplet identifier
     */
    private AbstractTriplet getTriplet(byte tripletId) {
        for (AbstractTriplet trip : triplets) {
            if (trip.getId() == tripletId) {
                return trip;
            }
        }
        return null;
    }

    
Returns true of this structured field has the given triplet
Params:
tripletId – the triplet identifier
Returns:
true if the structured field has the given triplet/**
     * Returns true of this structured field has the given triplet
     *
     * @param tripletId the triplet identifier
     * @return true if the structured field has the given triplet
     */
    public boolean hasTriplet(byte tripletId) {
        return getTriplet(tripletId) != null;
    }

    
Adds a triplet to this structured object
Params:
triplet – the triplet to add/**
     * Adds a triplet to this structured object
     *
     * @param triplet the triplet to add
     */
    public void addTriplet(AbstractTriplet triplet) {
        triplets.add(triplet);
    }

    
Adds a list of triplets to the triplets contained within this structured field
Params:
tripletCollection – a collection of triplets/**
     * Adds a list of triplets to the triplets contained within this structured field
     *
     * @param tripletCollection a collection of triplets
     */
    public void addTriplets(Collection<AbstractTriplet> tripletCollection) {
        if (tripletCollection != null) {
            triplets.addAll(tripletCollection);
        }
    }

    
Returns:
the triplet list pertaining to this resource/** @return the triplet list pertaining to this resource */
    protected List<AbstractTriplet> getTriplets() {
        return triplets;
    }

    
Sets the fully qualified name of this structured field
Params:
fqnType – the fully qualified name type of this resource
fqnFormat – the fully qualified name format of this resource
fqName – the fully qualified name of this resource/**
     * Sets the fully qualified name of this structured field
     *
     * @param fqnType the fully qualified name type of this resource
     * @param fqnFormat the fully qualified name format of this resource
     * @param fqName the fully qualified name of this resource
     */
    public void setFullyQualifiedName(byte fqnType, byte fqnFormat, String fqName) {
        addTriplet(new FullyQualifiedNameTriplet(fqnType, fqnFormat, fqName, false));
    }

    public void setFullyQualifiedName(byte fqnType, byte fqnFormat, String fqName, boolean utf16be) {
        addTriplet(new FullyQualifiedNameTriplet(fqnType, fqnFormat, fqName, utf16be));
    }

    
Returns:
the fully qualified name of this triplet or null if it does not exist/** @return the fully qualified name of this triplet or null if it does not exist */
    public String getFullyQualifiedName() {
        FullyQualifiedNameTriplet fqNameTriplet
            = (FullyQualifiedNameTriplet)getTriplet(AbstractTriplet.FULLY_QUALIFIED_NAME);
        if (fqNameTriplet != null) {
            return fqNameTriplet.getFullyQualifiedName();
        }
        LOG.warn(this + " has no fully qualified name");
        return null;
    }

    
Sets the objects classification
Params:
objectClass – the classification of the object
objectType – the MOD:CA registry object type entry for the given
       object/component type of the object
dataInContainer – whether the data resides in the container
containerHasOEG – whether the container has an object environment group
dataInOCD – whether the data resides in a object container data structured field/**
     * Sets the objects classification
     *
     * @param objectClass the classification of the object
     * @param objectType the MOD:CA registry object type entry for the given
     *        object/component type of the object
     * @param dataInContainer whether the data resides in the container
     * @param containerHasOEG whether the container has an object environment group
     * @param dataInOCD whether the data resides in a object container data structured field
     */
    public void setObjectClassification(
            byte objectClass, ObjectType objectType,
            boolean dataInContainer, boolean containerHasOEG, boolean dataInOCD) {
        addTriplet(
                new ObjectClassificationTriplet(
                        objectClass, objectType, dataInContainer, containerHasOEG, dataInOCD));
    }

    
Sets a comment on this resource
Params:
commentString – a comment string/**
     * Sets a comment on this resource
     *
     * @param commentString a comment string
     */
    public void setComment(String commentString) {
        addTriplet(new CommentTriplet(AbstractTriplet.COMMENT, commentString));
    }

}