org.danann.cernunnos.xml.NewDocumentPhrase.java Source code

Introduction

Here is the source code for org.danann.cernunnos.xml.NewDocumentPhrase.java

Source

/*
 * Copyright 2007 Andrew Wills
 *
 * 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.
 */

package org.danann.cernunnos.xml;

import org.dom4j.Branch;
import org.dom4j.DocumentFactory;

import org.danann.cernunnos.EntityConfig;
import org.danann.cernunnos.Formula;
import org.danann.cernunnos.Phrase;
import org.danann.cernunnos.Reagent;
import org.danann.cernunnos.ReagentType;
import org.danann.cernunnos.SimpleFormula;
import org.danann.cernunnos.SimpleReagent;
import org.danann.cernunnos.TaskRequest;
import org.danann.cernunnos.TaskResponse;

public final class NewDocumentPhrase implements Phrase {

    // Instance Members.
    private Phrase name;

    /*
     * Public API.
     */

    public static final Reagent NAME = new SimpleReagent("NAME", "descendant-or-self::text()", ReagentType.PHRASE,
            String.class,
            "Optional element name.  If provided, this task will create a root element with this NAME and return it.",
            null);

    public Formula getFormula() {
        Reagent[] reagents = new Reagent[] { NAME };
        return new SimpleFormula(NewDocumentPhrase.class, reagents);
    }

    public void init(EntityConfig config) {

        // Instance Members.
        this.name = (Phrase) config.getValue(NAME);

    }

    public Object evaluate(TaskRequest req, TaskResponse res) {

        Branch rslt = new DocumentFactory().createDocument();
        if (name != null) {
            rslt = rslt.addElement((String) name.evaluate(req, res));
        }
        return rslt;

    }

}