org.apache.cocoon.pipeline.component.sax.AbstractSerializer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cocoon-pipeline Show documentation
The core of Cocoon 3. A Servlet API independent implementation of pipelines.
There is a newer version: 3.0.0-alpha-3
/*
 * 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.pipeline.component.sax;

import java.io.OutputStream;
import java.util.Map;

import org.apache.cocoon.pipeline.component.Finisher;
import org.apache.cocoon.pipeline.component.PipelineComponent;
import org.apache.cocoon.pipeline.util.AbstractXMLPipe;
import org.apache.cocoon.pipeline.util.StringRepresentation;

public abstract class AbstractSerializer extends AbstractXMLPipe implements PipelineComponent, Finisher {

    private OutputStream outputStream;

    private String contentType;

    private Map configuration;

    private Map inputParameters;

    /**
     * @return A {@link Map} that contains all configuration parameters.
     */
    protected Map getConfiguration() {
        return this.configuration;
    }

    /**
     * 
     * {@inheritDoc}
     * 
     * @see org.apache.cocoon.pipeline.component.Finisher#getContentType()
     */
    public String getContentType() {
        return this.contentType;
    }

    /**
     * @return A {@link Map} that contains all pipeline input parameters.
     */
    protected Map getInputParameters() {
        return this.inputParameters;
    }

    /**
     * @return The {@link OutputStream} of the pipeline.
     */
    protected OutputStream getOutputStream() {
        return this.outputStream;
    }

    /**
     * 
     * {@inheritDoc}
     * 
     * @see org.apache.cocoon.pipeline.component.PipelineComponent#setConfiguration(java.util.Map)
     */
    public void setConfiguration(Map configuration) {
        if (configuration.containsKey("mime-type")) {
            this.contentType = (String) configuration.get("mime-type");
        }
    }

    /**
     * @param The type of the content produced by this serializer.
     */
    public void setContentType(String contentType) {
        this.contentType = contentType;
    }

    /**
     * {@inheritDoc}
     * 
     * @see org.apache.cocoon.pipeline.component.PipelineComponent#setup(java.util.Map)
     */
    public void setup(Map inputParameters) {
        this.inputParameters = inputParameters;
    }

    /**
     * {@inheritDoc}
     * 
     * @see org.apache.cocoon.pipeline.component.PipelineComponent#finish(java.lang.Exception)
     */
    public void finish(Exception exception) {
        // do nothing
    }

    /**
     * 
     * {@inheritDoc}
     * 
     * @see org.apache.cocoon.pipeline.component.Finisher#setOutputStream(java.io.OutputStream)
     */
    public void setOutputStream(OutputStream outputStream) {
        this.outputStream = outputStream;
    }

    /**
     * 
     * {@inheritDoc}
     * 
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        return StringRepresentation.buildString(this);
    }
}