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

package org.apache.fop.render.afp.modca.goca;

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

import org.apache.fop.render.afp.modca.AbstractStructuredAFPObject;
import org.apache.fop.render.afp.modca.PreparedAFPObject;

/**
 * A base class container of GOCA structured objects
 */
public abstract class AbstractGraphicsContainer extends AbstractStructuredAFPObject
implements PreparedAFPObject {
    
    /**
     * list of objects contained within this container  
     */
    protected List list = null;
    
    /**
     * Default constructor
     */
    public AbstractGraphicsContainer() {
    }
    
    /**
     * Named constructor
     * @param name the name of the container
     */
    public AbstractGraphicsContainer(String name) {
        super(name);
    }
    
    /**
     * {@inheritDoc}
     */
    protected void writeContent(OutputStream os) throws IOException {
        if (list != null) {
            super.writeObjectList(list, os);
        }
    }
    
    /**
     * Adds a given graphics drawing order to this container
     * @param drawingOrder the graphics drawing order
     * @return the drawingOrder if it was added, null otherwise
     */
    protected PreparedAFPObject addDrawingOrder(PreparedAFPObject drawingOrder) {
        log.debug(this + " adding " + drawingOrder);
        if (list == null) {
            this.list = new java.util.ArrayList();
        }
        list.add(drawingOrder);
        return drawingOrder;
    }
    
    /**
     * @return the current data length of this container including
     * all enclosed GOCA drawing objects (and their containers)
     */
    public int getDataLength() {
        int dataLen = 0;
        if (list != null) {
            Iterator it = list.iterator();
            while (it.hasNext()) {
                Object obj = it.next();
                if (obj instanceof PreparedAFPObject) {
                    dataLen += ((PreparedAFPObject)obj).getDataLength();
                }
            }
        }
        return dataLen;
    } 
}