buildframework/helium/sf/java/metadata/src/com/nokia/helium/metadata/ant/conditions/MetaDataRegexTestCondition.java
author wbernard
Fri, 13 Aug 2010 14:59:05 +0300
changeset 628 7c4a911dc066
parent 588 c7c26511138f
permissions -rw-r--r--
helium_11.0.0-e00f171ca185
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     1
/*
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     2
 * Copyright (c) 2007-2008 Nokia Corporation and/or its subsidiary(-ies).
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     3
 * All rights reserved.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     4
 * This component and the accompanying materials are made available
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     5
 * under the terms of the License "Eclipse Public License v1.0"
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     6
 * which accompanies this distribution, and is available
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     7
 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     8
 *
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     9
 * Initial Contributors:
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    10
 * Nokia Corporation - initial contribution.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    11
 *
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    12
 * Contributors:
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    13
 *
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    14
 * Description:  
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    15
 *
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    16
 */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    17
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    18
package com.nokia.helium.metadata.ant.conditions;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    19
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    20
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    21
import java.util.ArrayList;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    22
import java.util.List;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    23
import java.util.regex.Matcher;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    24
import java.util.regex.Pattern;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    25
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    26
import org.apache.tools.ant.BuildException;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    27
import org.apache.tools.ant.taskdefs.condition.Condition;
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
    28
import org.apache.tools.ant.types.DataType;
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    29
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    30
import com.nokia.helium.metadata.ant.types.MetaDataFilter;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    31
import com.nokia.helium.metadata.ant.types.MetaDataFilterSet;
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
    32
import com.nokia.helium.metadata.ant.types.SeverityEnum;
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    33
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    34
/**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    35
 * This class implements a Ant Condition which report true if it finds the given 
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
    36
 * input string is matched against the given filter of given severity
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    37
 * 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    38
 * Example:
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    39
 * <pre> 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    40
 *    &lt;target name=&quot;test-metadata-regex&quot;&gt;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    41
 *      &lt;au:assertTrue&gt;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    42
 *          &lt;hlm:metadataRegexTest severity=&quot;ERROR&quot; string=&quot;Error:&quot;&gt;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    43
 *              &lt;metadatafilterset refid=&quot;filterset.sbs&quot;/&gt;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    44
 *          &lt;/hlm:metadataRegexTest&gt;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    45
 *       &lt;/au:assertTrue&gt;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    46
 *   &lt;/target&gt;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    47
 * </pre>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    48
 * 
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
    49
 * The condition will eval as true if the string is matched with any of the pattern in the given severity
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    50
 * 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    51
 * @ant.type name="metadataRegexTest" category="Metadata"
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    52
 */
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
    53
public class MetaDataRegexTestCondition extends DataType implements Condition {
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    54
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
    55
    private SeverityEnum severity;
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    56
    private String string;  
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    57
    
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    58
    private List<MetaDataFilterSet> filterSets = new ArrayList<MetaDataFilterSet>();
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    59
    
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    60
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    61
     * Sets which severity to be searched.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    62
     * 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    63
     * @param severity
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    64
     * @ant.required
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    65
     */
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
    66
    public void setSeverity(SeverityEnum severity) {
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    67
        this.severity = severity;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    68
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    69
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    70
     * Sets which string to be matched against regular expression.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    71
     * 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    72
     * @param string
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    73
     * @ant.required
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    74
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    75
    public void setString(String string) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    76
        this.string = string;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    77
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    78
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    79
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    80
     * Helper function to add the created filter
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    81
     * @param filter to be added to the filterset
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    82
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    83
    public void add(MetaDataFilterSet filterSet) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    84
        if (filterSet != null) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    85
            filterSets.add(filterSet);
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    86
        }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    87
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    88
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    89
    
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    90
    
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    91
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    92
     * This method iterates through the regular expression patterns and match the input string against them.
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
    93
     * @return true if the string is matched with any of the pattern in the given severity, false otherwise.
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    94
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    95
    public boolean eval() {
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
    96
        if (this.severity == null) {
588
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents: 587
diff changeset
    97
            throw new BuildException("'severity' attribute is not defined");
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
    98
        }
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
    99
        if (this.string == null || (this.string != null && this.string.isEmpty())) {
588
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents: 587
diff changeset
   100
            throw new BuildException("'string' attribute is not defined");
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
   101
        }
588
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents: 587
diff changeset
   102
        for (MetaDataFilterSet set : filterSets) {
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents: 587
diff changeset
   103
            for (MetaDataFilter filter : set.getAllFilters()) {
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents: 587
diff changeset
   104
                Pattern pattern = filter.getPattern();
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents: 587
diff changeset
   105
                Matcher matcher = pattern.matcher(this.string);
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents: 587
diff changeset
   106
                if (matcher.matches()) {
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
   107
                    return severity.getSeverity().equals(filter.getSeverity());
588
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents: 587
diff changeset
   108
                }
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents: 587
diff changeset
   109
            }
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents: 587
diff changeset
   110
        }
c7c26511138f helium-10.0.0-bc45d50958fe
wbernard
parents: 587
diff changeset
   111
        return false;
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   112
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   113
}