RELEASE_2_1_13/src/blocks/template/java/org/apache/cocoon/template/script/event/StartDocument.java

/*
 * 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.cocoon.template.script.event;

import java.util.HashMap;
import java.util.Map;

import org.apache.cocoon.components.expression.ExpressionContext;
import org.apache.cocoon.template.environment.ExecutionContext;
import org.apache.cocoon.template.instruction.MacroContext;
import org.apache.cocoon.xml.XMLConsumer;
import org.apache.excalibur.source.SourceValidity;
import org.xml.sax.Locator;
import org.xml.sax.SAXException;

/**
 * @version SVN $Id$
 */
public class StartDocument extends Event {
    public StartDocument(Locator location) {
        super(location);
        templateProperties = new HashMap();
    }

    private SourceValidity sourceValidity;
    private String uri;
    private EndDocument endDocument; // null if document fragment
    private Map templateProperties;

    public EndDocument getEndDocument() {
        return endDocument;
    }

    public void setEndDocument(EndDocument endDoc) {
        this.endDocument = endDoc;
    }

    public Map getTemplateProperties() {
        return templateProperties;
    }

    public String getUri() {
        return this.uri;
    }

    public void setUri(String uri) {
        this.uri = uri;
    }

    /**
     * @param sourceValidity
     *            The compileTime to set.
     */
    public void setSourceValidity(SourceValidity sourceValidity) {
        this.sourceValidity = sourceValidity;
    }

    /**
     * @return Returns the compileTime.
     */
    public SourceValidity getSourceValidity() {
        return sourceValidity;
    }

    /**
     * @param name
     */
    public Object getTemplateProperty(String name) {
        return getTemplateProperties().get(name);
    }

    public Event execute(XMLConsumer consumer,
            ExpressionContext expressionContext,
            ExecutionContext executionContext, MacroContext macroContext,
            Event startEvent, Event endEvent) throws SAXException {
        if (getEndDocument() != null)
            consumer.startDocument();
        return getNext();
    }
}