001/*
002    Licensed to the Apache Software Foundation (ASF) under one
003    or more contributor license agreements.  See the NOTICE file
004    distributed with this work for additional information
005    regarding copyright ownership.  The ASF licenses this file
006    to you under the Apache License, Version 2.0 (the
007    "License"); you may not use this file except in compliance
008    with the License.  You may obtain a copy of the License at
009
010       http://www.apache.org/licenses/LICENSE-2.0
011
012    Unless required by applicable law or agreed to in writing,
013    software distributed under the License is distributed on an
014    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015    KIND, either express or implied.  See the License for the
016    specific language governing permissions and limitations
017    under the License.
018 */
019package org.apache.wiki.render;
020
021import java.io.IOException;
022
023import org.apache.wiki.WikiContext;
024import org.apache.wiki.parser.WikiDocument;
025
026/**
027 *  Provides an interface to the basic rendering engine.
028 *  This class is an abstract class instead of an interface because
029 *  it is expected that rendering capabilities are increased at some
030 *  point, and I would hate if renderers broke.  This class allows
031 *  some sane defaults to be implemented.
032 *
033 *  @since  2.4
034 */
035public abstract class WikiRenderer
036{
037    protected WikiContext     m_context;
038    protected WikiDocument    m_document;
039
040    public static final String LINKS_TRANSLATION = "$1#$2";
041    public static final String LINKS_SOURCE = "(.+)#section-.+-(.+)";
042
043    /**
044     *  Create a WikiRenderer.
045     *
046     *  @param context A WikiContext in which the rendering will take place.
047     *  @param doc The WikiDocument which shall be rendered.
048     */
049    protected WikiRenderer( WikiContext context, WikiDocument doc )
050    {
051        m_context = context;
052        m_document = doc;
053        doc.setContext( context ); // Make sure it is set
054    }
055
056    /**
057     *  Renders and returns the end result.
058     *
059     *  @return A rendered string.
060     *  @throws IOException If rendering fails.
061     */
062    public abstract String getString()
063        throws IOException;
064
065}