001    package org.apache.torque.task;
002    
003    /*
004     * Licensed to the Apache Software Foundation (ASF) under one
005     * or more contributor license agreements.  See the NOTICE file
006     * distributed with this work for additional information
007     * regarding copyright ownership.  The ASF licenses this file
008     * to you under the Apache License, Version 2.0 (the
009     * "License"); you may not use this file except in compliance
010     * with the License.  You may obtain a copy of the License at
011     *
012     *   http://www.apache.org/licenses/LICENSE-2.0
013     *
014     * Unless required by applicable law or agreed to in writing,
015     * software distributed under the License is distributed on an
016     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017     * KIND, either express or implied.  See the License for the
018     * specific language governing permissions and limitations
019     * under the License.
020     */
021    
022    import org.apache.velocity.context.Context;
023    
024    /**
025     * An ant task for generating output by using Velocity
026     *
027     * @author <a href="mailto:mpoeschl@marmot.at">Martin Poeschl</a>
028     * @version $Id: TorqueDocumentationTask.java,v 1.1 2007-10-21 07:57:26 abyrne Exp $
029     */
030    public class TorqueDocumentationTask extends TorqueDataModelTask
031    {
032        /** output format for the generated docs */
033        private String outputFormat;
034    
035        /**
036         * Get the current output format.
037         *
038         * @return the current output format
039         */
040        public String getOutputFormat()
041        {
042            return outputFormat;
043        }
044    
045        /**
046         * Set the current output format.
047         *
048         * @param v output format
049         */
050        public void setOutputFormat(String v)
051        {
052            outputFormat = v;
053        }
054    
055        /**
056         * Place our target package value into the context for use in the templates.
057         *
058         * @return the context
059         * @throws Exception a generic exception
060         */
061        public Context initControlContext() throws Exception
062        {
063            super.initControlContext();
064            context.put("outputFormat", outputFormat);
065            context.put("escape", new org.apache.velocity.anakia.Escape());
066            return context;
067        }
068    }