de.extra.client.core.responce.impl.ResponseData.java Source code

Introduction

Here is the source code for de.extra.client.core.responce.impl.ResponseData.java

Source

/*
 * 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 de.extra.client.core.responce.impl;

import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;

import org.springframework.util.Assert;

import de.extrastandard.api.model.content.IResponseData;
import de.extrastandard.api.model.content.ISingleResponseData;

/**
 * Daten eines Responses
 * 
 * @author Leonid Potap
 * @version $Id$
 */
public class ResponseData implements IResponseData {

    private final Map<String, Collection<ISingleResponseData>> responseDatenMap = new HashMap<String, Collection<ISingleResponseData>>();

    // (04.01.13) Warnung (z.B. keine Ergebnisdatei)
    private Boolean warning = false;
    // TODO (04.01.13) wird das Attribut 'successful' benoetigt?

    /*
     * (non-Javadoc)
     * 
     * @see de.extrastandard.api.model.content.IResponseData#getReponses()
     */
    @Override
    public Collection<ISingleResponseData> getResponses() {
        Collection<ISingleResponseData> allResponsesList = new ArrayList<ISingleResponseData>();

        for (Collection<ISingleResponseData> reponseDatalist : responseDatenMap.values()) {
            allResponsesList.addAll(reponseDatalist);
        }
        return allResponsesList;
    }

    /**
     * Wird benoetigt, um bei bestimmten Ereignissen (z.B. keine Ergebnisdatei vorhanden) eine Warnung signalisieren zu knnen.
     * @param warning
     */
    public void setWarning(Boolean warning) {
        this.warning = warning;
    }

    /*
     * (non-Javadoc)
     * 
     * @see
     * de.extrastandard.api.model.content.IResponseData#getResponse(java.lang
     * .String)
     */
    @Override
    public Collection<ISingleResponseData> getResponse(final String reguestId) {
        return responseDatenMap.get(reguestId);
    }

    /**
     * Fgt einen neuen Datensatz zu den Responses
     * 
     * @param singleResponseData
     */
    @Override
    public void addSingleResponse(final ISingleResponseData singleResponseData) {
        Assert.notNull(singleResponseData, "Response is null");
        String requestId = singleResponseData.getRequestId();
        Assert.notNull(requestId, "requestId is null");

        Collection<ISingleResponseData> singleResponsesList = responseDatenMap.get(requestId);
        if (singleResponsesList == null) {
            singleResponsesList = new ArrayList<ISingleResponseData>();
        }
        singleResponsesList.add(singleResponseData);
        responseDatenMap.put(requestId, singleResponsesList);

    }

    /**
     * Eine Response ist erfolgreich, wenn alle Response-Objekte erfolgreich sind.
     */
    @Override
    public Boolean isSuccessful() {
        if (getResponses() != null) {
            for (final ISingleResponseData iResponseData : getResponses()) {
                if (!iResponseData.isSuccessful()) {
                    return false;
                }
            }
        }
        return true;
    }

    /**
     * Eine Warnung liegt dann vor, wenn fr ein Response-Objekt eine Warnung vorliegt oder wenn fr die Gesamt-Response eine Warnung vorliegt.
     */
    @Override
    public Boolean isWarning() {
        if (getResponses() != null) {
            for (final ISingleResponseData iResponseData : getResponses()) {
                if (iResponseData.isWarning()) {
                    return true;
                }
            }
        }
        return warning;
    }

    /*
     * (non-Javadoc)
     * 
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        final StringBuilder builder = new StringBuilder();
        builder.append("ResponseData [");
        final Collection<ISingleResponseData> responses = getResponses();
        if (responses != null && !responses.isEmpty()) {
            for (final ISingleResponseData singleResponseData : responses) {
                builder.append(" SingleResponseData: ").append(singleResponseData);
            }
        }
        builder.append("]");
        return builder.toString();
    }

}