[tmp/jakarta-migration.git] /

/**\r
 * This document is a part of the source code and related artifacts\r
 * for CollectionSpace, an open source collections management system\r
 * for museums and related institutions:\r
 *\r
 * http://www.collectionspace.org\r
 * http://wiki.collectionspace.org\r
 *\r
 * Copyright (c) 2009 Regents of the University of California\r
 *\r
 * Licensed under the Educational Community License (ECL), Version 2.0.\r
 * You may not use this file except in compliance with this License.\r
 *\r
 * You may obtain a copy of the ECL 2.0 License at\r
 * https://source.collectionspace.org/collection-space/LICENSE.txt\r
 *\r
 *  Unless required by applicable law or agreed to in writing, software\r
 *  distributed under the License is distributed on an "AS IS" BASIS,\r
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
 *  See the License for the specific language governing permissions and\r
 *  limitations under the License.\r
 */\r
\r
package org.collectionspace.services.IntegrationTests.xmlreplay;\r
\r
import org.collectionspace.services.common.api.Tools;\r
\r
import java.util.ArrayList;\r
\r
/**\r
 * User: laramie\r
 * $LastChangedRevision:  $\r
 * $LastChangedDate:  $\r
 */\r
public class TreeWalkResults extends ArrayList<TreeWalkResults.TreeWalkEntry> {\r
\r
    public static class TreeWalkEntry {\r
        public String lpath = "";\r
        public String rpath = "";\r
        public String ltextTrimmed = "";\r
        public String rtextTrimmed = "";\r
        public String expected = "";\r
        public String actual = "";\r
        public String message = "";\r
        public String errmessage = "";\r
        public static enum STATUS {INFO, MATCHED, R_MISSING, R_ADDED, DOC_ERROR, TEXT_DIFFERENT};\r
        public STATUS status;\r
        public String toString(){\r
            return\r
                 "{"\r
                 +status.name()\r
                 +(Tools.notEmpty(lpath) ? ", L.path:"+lpath : "")\r
                 +(Tools.notEmpty(rpath) ? ", R.path:"+rpath : "")\r
                 +(Tools.notEmpty(message) ? ", message:"+message : "")\r
                 +(Tools.notEmpty(errmessage) ? ", errmessage:"+errmessage : "")\r
                 +", status:"+status\r
                 +((status != STATUS.MATCHED) && Tools.notEmpty(ltextTrimmed) ? ",\r\n    L.trimmed:"+ltextTrimmed : "")\r
                 +((status != STATUS.MATCHED) && Tools.notEmpty(rtextTrimmed) ? ",\r\n    R.trimmed:"+rtextTrimmed : "")\r
                 +((status != STATUS.MATCHED) && Tools.notEmpty(expected) ? "\r\nEXPECTED:\r\n------------------\r\n"+expected.trim()+"\r\n------------------" : "")\r
                 +((status != STATUS.MATCHED) && Tools.notEmpty(actual) ? "\r\nACTUAL:\r\n------------------\r\n"+actual.trim()+"\r\n------------------\r\n" : "")\r
\r
                 +"}";\r
\r
        }\r
    }\r
\r
    public boolean hasDocErrors(){\r
        for (TreeWalkEntry entry : this){\r
            if (entry.status == TreeWalkEntry.STATUS.DOC_ERROR){\r
                return true;\r
            }\r
        }\r
        return false;\r
    }\r
\r
    public String getErrorMessages(){\r
        StringBuffer buf = new StringBuffer();\r
        boolean first = true;\r
        for (TreeWalkEntry entry : this){\r
            if ( Tools.notEmpty(entry.errmessage)){\r
                if (first) {\r
                    buf.append(",errors:");\r
                } else {\r
                    buf.append(',');\r
                }\r
                buf.append('\''+entry.errmessage+"\'");\r
                first = false;\r
            }\r
        }\r
        return buf.toString();\r
    }\r
\r
\r
\r
    public boolean isStrictMatch(){\r
        for (TreeWalkEntry entry : this){\r
            if (entry.status == TreeWalkEntry.STATUS.DOC_ERROR){\r
                return false;\r
            }\r
            if ( !(   entry.status == TreeWalkEntry.STATUS.MATCHED\r
                   || entry.status == TreeWalkEntry.STATUS.INFO)){\r
                return false;\r
            }\r
        }\r
        return true;\r
    }\r
    public int getMismatchCount(){\r
        int c = 0;\r
        for (TreeWalkEntry entry : this){\r
            if ( entry.status == TreeWalkEntry.STATUS.DOC_ERROR\r
                || entry.status != TreeWalkEntry.STATUS.MATCHED\r
                || entry.status != TreeWalkEntry.STATUS.INFO){\r
                c++;\r
            }\r
        }\r
        return c;\r
    }\r
    /** For our purposes, trees match if they have the same element tree structure - no checking is done for text node changes. */\r
    public boolean treesMatch(){\r
        for (TreeWalkEntry entry : this){\r
            if (entry.status == TreeWalkEntry.STATUS.DOC_ERROR\r
                || entry.status == TreeWalkEntry.STATUS.R_MISSING\r
                || entry.status == TreeWalkEntry.STATUS.R_ADDED  ){\r
                return false;\r
            }\r
        }\r
        return true;\r
    }\r
\r
    public int countFor(TreeWalkEntry.STATUS status){\r
        int count = 0;\r
        for (TreeWalkEntry entry : this){\r
            if (entry.status.equals(status)){\r
                count++;\r
            }\r
        }\r
        return count;\r
    }\r
\r
    public String miniSummary(){\r
        //MATCHED, INFO, R_MISSING, R_ADDED, TEXT_DIFFERENT};\r
        StringBuffer buf = new StringBuffer();\r
        buf.append("{");\r
        boolean nextline = false;\r
        for (TreeWalkEntry.STATUS st : TreeWalkEntry.STATUS.values()){\r
            if (nextline) buf.append(',');\r
            buf.append(st.name()+':'+countFor(st));\r
            nextline = true;\r
        }\r
        buf.append(getErrorMessages());\r
        buf.append("}");\r
        return buf.toString();\r
    }\r
\r
    public String fullSummary(){\r
        StringBuffer buf = new StringBuffer();\r
        for (TreeWalkResults.TreeWalkEntry entry : this){\r
            buf.append(entry.toString()).append("\r\n");\r
        }\r
        return buf.toString();\r
    }\r
\r
\r
    public String leftID;\r
    public String rightID;\r
}