/*
 *  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.synapse.config.xml;

import org.apache.axiom.om.OMElement;
import org.apache.synapse.Mediator;
import org.apache.synapse.mediators.builtin.ForEachMediator;

/**
 * <p>Serialize for each mediator as below : </p>
 * <p/>
 * <pre>
 * &lt;foreach expression="xpath" [sequence="sequence_ref"] [id="foreach_id"] &gt;
 *     &lt;sequence&gt;
 *       (mediator)+
 *     &lt;/sequence&gt;?
 * &lt;/foreach&gt;
 * </pre>
 */
public class ForEachMediatorSerializer extends AbstractMediatorSerializer {

    public String getMediatorClassName() {
        return ForEachMediator.class.getName();
    }

    @Override
    protected OMElement serializeSpecificMediator(Mediator m) {
        if (!(m instanceof ForEachMediator)) {
            handleException("Unsupported mediator passed in for serialization : " +
                    m.getType());
        }

        OMElement forEachElem = fac.createOMElement("foreach", synNS);
        saveTracingState(forEachElem, m);

        ForEachMediator forEachMed = (ForEachMediator) m;

        if (forEachMed.getId() != null) {
            forEachElem.addAttribute("id", forEachMed.getId(), nullNS);
        }

        if (forEachMed.getExpression() != null) {
            SynapseXPathSerializer.serializeXPath(forEachMed.getExpression(),
                    forEachElem, "expression");
        } else {
            handleException("Missing expression of the ForEach which is required.");
        }

        if (forEachMed.getSequenceRef() != null) {
            forEachElem.addAttribute("sequence", forEachMed.getSequenceRef(), null);
        } else if (forEachMed.getSequence() != null) {
            SequenceMediatorSerializer seqSerializer = new SequenceMediatorSerializer();
            OMElement seqElement = seqSerializer.serializeAnonymousSequence(
                    null, forEachMed.getSequence());
            seqElement.setLocalName("sequence");
            forEachElem.addChild(seqElement);
        }

        serializeComments(forEachElem, forEachMed.getCommentsList());

        return forEachElem;
    }
}
