org.efaps.update.schema.program.WikiUpdate Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of efaps-kernel Show documentation

eFaps is a framework used to map objects with or without attached files to a relational database and optional file systems (only for attaches files). Configurable access control can be provided down to object and attribute level depending on implementation and use case. Depending on requirements, events (like triggers) allow to implement business logic and to separate business logic from user interface. The framework includes integrations (e.g. webdav, full text search) and a web application as 'simple' configurable user interface. Some best practises, example web application modules (e.g. team work module) support administrators and implementers using this framework.

There is a newer version: 3.2.0

Show newest version

/*
 * Copyright 2003 - 2012 The eFaps Team
 *
 * Licensed 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.
 *
 * Revision:        $Rev: 7483 $
 * Last Changed:    $Date: 2012-05-11 11:57:38 -0500 (Fri, 11 May 2012) $
 * Last Changed By: $Author: [email protected] $
 */

package org.efaps.update.schema.program;

import java.net.URL;
import java.util.HashSet;
import java.util.Set;

import org.efaps.update.schema.program.staticsource.WikiImporter;
import org.efaps.update.util.InstallationException;

/**
 * TODO comment!
 *
 * @author The eFaps Team
 * @version $Id: WikiUpdate.java 7483 2012-05-11 16:57:38Z [email protected] $
 */
public class WikiUpdate extends AbstractSourceUpdate
{
    /**
     * Link from Wiki to other Wiki.
     */
    private static final Link LINK2WIKI = new Link("Admin_Program_Wiki2Wiki", "From",
                                                    "Admin_Program_Wiki", "To");

    /**
     * Set off all links for this JasperReportUpdate.
     */
    private static final Set ALLLINKS = new HashSet();
    static {
        WikiUpdate.ALLLINKS.add(WikiUpdate.LINK2WIKI);
    }

    /**
     * @param _url URL of the file
     *
     */
    public WikiUpdate(final URL _url)
    {
        super(_url, "Admin_Program_Wiki", WikiUpdate.ALLLINKS);
    }

    /**
     * Read the file.
     *
     * @param _url URL to the file
     * @return JavaScriptUpdate
     */
    public static WikiUpdate readFile(final URL _url)
    {
        final WikiUpdate ret = new WikiUpdate(_url);
        final WikiDefinition definition = ret.new WikiDefinition(_url);
        ret.addDefinition(definition);
        return ret;
    }

    /**
     * Definition for the JasperReport.
     *
     */
    public class WikiDefinition extends AbstractSourceDefinition
    {

        /**
         * Importer for the JasperReport.
         */
        private WikiImporter wiki = null;

        /**
         * Construtor.
         *
         * @param _url URL to the JasperReport file
         *
         */
        public WikiDefinition(final URL _url)
        {
            super(_url);
        }

        /**
         * Search the instance.
         *
         * @throws InstallationException if the source code for the Jasper
         *                               Report could not be read or file could
         *                               not be accessed because of the wrong
         *                               URL
         */
        @Override
        protected void searchInstance()
            throws InstallationException
        {
            if (this.wiki == null) {
                this.wiki = new WikiImporter(getUrl());
            }
            setName(this.wiki.getProgramName());

            if (this.wiki.getEFapsUUID() != null) {
                addValue("UUID", this.wiki.getEFapsUUID().toString());
            }

            if (getInstance() == null) {
                setInstance(this.wiki.searchInstance());
            }
        }

        /**
         * {@inheritDoc}
         */
        @Override
        protected String getRevision()
            throws InstallationException
        {
            if (this.wiki == null) {
                this.wiki = new WikiImporter(getUrl());
            }
            return this.wiki.getRevision();
        }
    }
}