Examples of org.apache.commons.digester3.CallMethodRule

org.apache.commons.digester3.Digester

Rule implementation that calls a method on an object on the stack (normally the top/parent object), passing arguments collected from subsequent CallParamRule rules or from the body of this element.

By using {@link #CallMethodRule(String methodName)} a method call can be made to a method which accepts no arguments.

Incompatible method parameter types are converted using org.apache.commons.beanutils.ConvertUtils.

This rule now uses {@link org.apache.commons.beanutils.MethodUtils#invokeMethod} by default.This increases the kinds of methods successfully and allows primitives to be matched by passing in wrapper classes. There are rare cases when {@link org.apache.commons.beanutils.MethodUtils#invokeExactMethod} (the old default) isrequired. This method is much stricter in it's reflection. Setting the UseExactMatch to true reverts to the use of this method.

Note that the target method is invoked when the end of the tag the CallMethodRule fired on is encountered, not when the last parameter becomes available. This implies that rules which fire on tags nested within the one associated with the CallMethodRule will fire before the CallMethodRule invokes the target method. This behavior is not configurable.

Note also that if a CallMethodRule is expecting exactly one parameter and that parameter is not available (eg CallParamRule is used with an attribute name but the attribute does not exist) then the method will not be invoked. If a CallMethodRule is expecting more than one parameter, then it is always invoked, regardless of whether the parameters were available or not; missing parameters are converted to the appropriate target type by calling ConvertUtils.convert. Note that the default ConvertUtils converters for the String type returns a null when passed a null, meaning that CallMethodRule will passed null for all String parameters for which there is no parameter info available from the XML. However parameters of type Float and Integer will be passed a real object containing a zero value as that is the output of the default ConvertUtils converters for those types when passed a null. You can register custom converters to change this behavior; see the BeanUtils library documentation for more info.

Note that when a constructor is used with paramCount=0, indicating that the body of the element is to be passed to the target method, an empty element will cause an empty string to be passed to the target method, not null. And if automatic type conversion is being applied (ie if the target function takes something other than a string as a parameter) then the conversion will fail if the converter class does not accept an empty string as valid input.

CallMethodRule has a design flaw which can cause it to fail under certain rule configurations. All CallMethodRule instances share a single parameter stack, and all CallParamRule instances simply store their data into the parameter-info structure that is on the top of the stack. This means that two CallMethodRule instances cannot be associated with the same pattern without getting scrambled parameter data. This same issue also applies when a CallMethodRule matches some element X, a different CallMethodRule matches a child element Y and some of the CallParamRules associated with the first CallMethodRule match element Y or one of its child elements. This issue has been present since the very first release of Digester. Note, however, that this configuration of CallMethodRule instances is not commonly required.

        expander.addSource( "$", mutableSource );
        digester.setSubstitutor( new VariableSubstitutor( expander ) );


        int useRootObj = -1;
        Class<?>[] callerArgTypes = new Class[] { String.class, String.class };
        CallMethodRule caller = new CallMethodRule( useRootObj, "addProperty", callerArgTypes.length, callerArgTypes );
        digester.addRule( "root/property", caller );
        digester.addCallParam( "root/property", 0, "name" );
        digester.addCallParam( "root/property", 1, "value" );


        digester.addObjectCreate( "root/bean", SimpleTestBean.class );

View Full Code Here

        expander.addSource( "$", mutableSource );
        digester.setSubstitutor( new VariableSubstitutor( expander ) );


        int useRootObj = -1;
        Class<?>[] callerArgTypes = new Class[] { String.class, String.class };
        CallMethodRule caller = new CallMethodRule( useRootObj, "addProperty", callerArgTypes.length, callerArgTypes );
        digester.addRule( "root/property", caller );
        digester.addCallParam( "root/property", 0, "name" );
        digester.addCallParam( "root/property", 1, "value" );


        digester.addObjectCreate( "root/bean", SimpleTestBean.class );

View Full Code Here

     * {@inheritDoc}
     */
    @Override
    protected CallMethodRule createRule()
    {
        CallMethodRule callMethodRule = new CallMethodRule( targetOffset, methodName, paramCount, paramTypes );
        callMethodRule.setUseExactMatch( useExactMatch );
        return callMethodRule;
    }

View Full Code Here


        PlanParser.addCreateUpload(digester, "*/experiment/results/result", null, DigitalObject.class);
        PlanParser.addCreateUpload(digester, "*/result/xcdlDescription", "setXcdlDescription", XcdlDescription.class);


        // call function addUpload of ExperimentWrapper
        CallMethodRule r = new CallMethodRule(1, "addResult", 2); // method
                                                                  // with
                                                                  // two
                                                                  // params
        // every time */experiment/uploads/upload is encountered
        digester.addRule("*/experiment/results/result", r);
        // use attribute "key" as first param
        digester.addCallParam("*/experiment/results/result", 0, "key");
        // and the object on stack (DigitalObject) as the second
        digester.addCallParam("*/experiment/results/result", 1, true);


        // addCreateUpload(digester,
        // "*/experiment/xcdlDescriptions/xcdlDescription", null,
        // XcdlDescription.class);
        // // call function addXcdlDescription of ExperimentWrapper
        // r = new CallMethodRule(1, "addXcdlDescription", 2); //method with
        // two
        // params
        // // every time */experiment/xcdlDescriptions/xcdlDescription is
        // encountered
        // digester.addRule("*/experiment/xcdlDescriptions/xcdlDescription",
        // r);
        // // use attribute "key" as first param
        // digester.addCallParam("*/experiment/xcdlDescriptions/xcdlDescription",
        // 0 , "key");http://fue.onb.ac.at/abo/data
        // // and the object on stack (DigitalObject) as the second
        // digester.addCallParam("*/experiment/xcdlDescriptions/xcdlDescription",1,true);


        digester.addObjectCreate("*/experiment/detailedInfos/detailedInfo", DetailedExperimentInfo.class);
        digester.addSetProperties("*/experiment/detailedInfos/detailedInfo");
        digester.addBeanPropertySetter("*/experiment/detailedInfos/detailedInfo/programOutput");
        digester.addBeanPropertySetter("*/experiment/detailedInfos/detailedInfo/cpr");


        // call function "addDetailedInfo" of ExperimentWrapper
        r = new CallMethodRule(1, "addDetailedInfo", 2); // method with two
                                                         // params
        // every time */experiment/detailedInfos/detailedInfo is encountered
        digester.addRule("*/experiment/detailedInfos/detailedInfo", r);
        // use attribute "key" as first param
        digester.addCallParam("*/experiment/detailedInfos/detailedInfo", 0, "key");
        // and the object on stack as second parameter
        digester.addCallParam("*/experiment/detailedInfos/detailedInfo", 1, true);


        // read contained measurements:
        digester.addObjectCreate("*/detailedInfo/measurements/measurement", Measurement.class);
        digester.addSetProperties("*/detailedInfo/measurements/measurement");
        digester.addSetNext("*/detailedInfo/measurements/measurement", "put");
        // values are defined with wild-cards, and therefore set
        // automatically


        /*
         * for each value type a set of rules because of FreeStringValue we need
         * to store the value as XML-element instead of an attribute naming them
         * "ResultValues" wasn't nice too
         */
        PlanParser.addCreateValue(digester, BooleanValue.class, "setValue");
        PlanParser.addCreateValue(digester, FloatRangeValue.class, "setValue");
        PlanParser.addCreateValue(digester, IntegerValue.class, "setValue");
        PlanParser.addCreateValue(digester, IntRangeValue.class, "setValue");
        PlanParser.addCreateValue(digester, OrdinalValue.class, "setValue");
        PlanParser.addCreateValue(digester, PositiveFloatValue.class, "setValue");
        PlanParser.addCreateValue(digester, PositiveIntegerValue.class, "setValue");
        PlanParser.addCreateValue(digester, YanValue.class, "setValue");
        PlanParser.addCreateValue(digester, FreeStringValue.class, "setValue");


        // go no go decision
        digester.addObjectCreate("*/plan/decision", Decision.class);
        digester.addSetProperties("*/plan/decision");
        digester.addSetNext("*/plan/decision", "setDecision");


        digester.addCallMethod("*/plan/decision/actionNeeded", "setActionNeeded", 0);
        digester.addCallMethod("*/plan/decision/reason", "setReason", 0);


        digester.addFactoryCreate("*/plan/decision/goDecision", GoDecisionFactory.class);
        digester.addSetNext("*/plan/decision/goDecision", "setDecision");


        // evaluation
        digester.addObjectCreate("*/plan/evaluation", Evaluation.class);
        digester.addSetProperties("*/plan/evaluation");
        digester.addSetNext("*/plan/evaluation", "setEvaluation");


        digester.addCallMethod("*/plan/evaluation/comment", "setComment", 0);


        // importance weighting
        digester.addObjectCreate("*/plan/importanceWeighting", ImportanceWeighting.class);
        digester.addSetProperties("*/plan/importanceWeighting");
        digester.addSetNext("*/plan/importanceWeighting", "setImportanceWeighting");


        digester.addCallMethod("*/plan/importanceWeighting/comment", "setComment", 0);


        // recommendation
        digester.addObjectCreate("*/plan/recommendation", RecommendationWrapper.class);
        digester.addSetProperties("*/plan/recommendation");
        digester.addSetNext("*/plan/recommendation", "setRecommendation");


        digester.addCallMethod("*/plan/recommendation/reasoning", "setReasoning", 0);
        digester.addCallMethod("*/plan/recommendation/effects", "setEffects", 0);


        // transformation
        digester.addObjectCreate("*/plan/transformation", Transformation.class);
        digester.addSetProperties("*/plan/transformation");
        digester.addSetNext("*/plan/transformation", "setTransformation");


        digester.addCallMethod("*/plan/transformation/comment", "setComment", 0);


        // Tree
        /*
         * Some rules for tree parsing are necessary for importing templates
         * too, that's why they are added by this static method.
         */
        PlanParser.addTreeParsingRulesToDigester(digester);


        digester.addObjectCreate("*/leaf/evaluation", HashMap.class);
        digester.addSetNext("*/leaf/evaluation", "setValueMap");
        /*
         * The valueMap has an entry for each (considered) alternative ... and
         * for each alternative there is a list of values, one per SampleObject.
         * Note: The digester uses a stack, therefore the rule to put the list
         * of values to the valueMap must be added after the rule for adding the
         * values to the list.
         */


        /*
         * 2. and for each alternative there is a list of values, one per
         * SampleObject
         */
        digester.addObjectCreate("*/leaf/evaluation/alternative", Values.class);
        digester.addCallMethod("*/leaf/evaluation/alternative/comment", "setComment", 0);


        /*
         * for each result-type a set of rules they are added to the valueMap by
         * the rules above
         */
        PlanParser.addCreateResultValue(digester, BooleanValue.class);
        PlanParser.addCreateResultValue(digester, FloatValue.class);
        PlanParser.addCreateResultValue(digester, FloatRangeValue.class);
        PlanParser.addCreateResultValue(digester, IntegerValue.class);
        PlanParser.addCreateResultValue(digester, IntRangeValue.class);
        PlanParser.addCreateResultValue(digester, OrdinalValue.class);
        PlanParser.addCreateResultValue(digester, PositiveFloatValue.class);
        PlanParser.addCreateResultValue(digester, PositiveIntegerValue.class);
        PlanParser.addCreateResultValue(digester, YanValue.class);
        PlanParser.addCreateResultValue(digester, FreeStringValue.class);


        /*
         * 1. The valueMap has an entry for each (considered) alternative ...
         */
        // call put of the ValueMap (HashMap)
        r = new CallMethodRule(1, "put", 2);
        digester.addRule("*/leaf/evaluation/alternative", r);
        digester.addCallParam("*/leaf/evaluation/alternative", 0, "key");
        digester.addCallParam("*/leaf/evaluation/alternative", 1, true);


        // digester.addObjectCreate("*/plan/executablePlan/planWorkflow",

View Full Code Here


        digester.addObjectCreate("*/ordinalTransformer/mappings", LinkedHashMap.class);
        digester.addSetNext("*/ordinalTransformer/mappings", "setMapping");
        digester.addFactoryCreate("*/mappings/mapping", OrdinalTransformerMappingFactory.class);


        digester.addRule("*/mappings/mapping", new CallMethodRule(1, "put", 2)); // method
                                                                                 // with
                                                                                 // two
                                                                                 // params
        digester.addCallParam("*/mappings/mapping", 0, "ordinal"); // use
                                                                   // attribute

View Full Code Here

     * 
     * @return a Digester with rules and variable substitutor
     */
    private Digester createDigesterThatCanDoAnt()
    {
        Digester digester = new Digester();


        MultiVariableExpander expander = new MultiVariableExpander();
        expander.addSource( "$", mutableSource );
        digester.setSubstitutor( new VariableSubstitutor( expander ) );


        int useRootObj = -1;
        Class<?>[] callerArgTypes = new Class[] { String.class, String.class };
        CallMethodRule caller = new CallMethodRule( useRootObj, "addProperty", callerArgTypes.length, callerArgTypes );
        digester.addRule( "root/property", caller );
        digester.addCallParam( "root/property", 0, "name" );
        digester.addCallParam( "root/property", 1, "value" );


        digester.addObjectCreate( "root/bean", SimpleTestBean.class );
        digester.addSetProperties( "root/bean" );
        digester.addSetNext( "root/bean", "addSimpleTestBean" );
        return digester;
    }

View Full Code Here

        throws SAXException, IOException
    {


        String xml = "<root alpha='${attr1}' beta='var{attr2}'/>";
        StringReader input = new StringReader( xml );
        Digester digester = new Digester();


        // Configure the digester as required
        digester.addObjectCreate( "root", SimpleTestBean.class );
        digester.addSetProperties( "root" );


        // Parse our test input.
        SimpleTestBean root = digester.parse( input );


        assertNotNull( "Digester returned no object", root );


        assertEquals( "${attr1}", root.getAlpha() );
        assertEquals( "var{attr2}", root.getBeta() );

View Full Code Here

        throws SAXException, IOException
    {


        String xml = "<root alpha='${attr1}' beta='var{attr2}'/>";
        StringReader input = new StringReader( xml );
        Digester digester = new Digester();


        // Configure the digester as required
        MultiVariableExpander expander = new MultiVariableExpander();
        digester.setSubstitutor( new VariableSubstitutor( expander ) );
        digester.addObjectCreate( "root", SimpleTestBean.class );
        digester.addSetProperties( "root" );


        // Parse our test input.
        SimpleTestBean root = digester.parse( input );


        assertNotNull( "Digester returned no object", root );


        assertEquals( "${attr1}", root.getAlpha() );
        assertEquals( "var{attr2}", root.getBeta() );

View Full Code Here

        String xml =
            "<root>" + "<bean alpha='${attr1}' beta='var{attr1}'/>" + "<bean alpha='${attr2}' beta='var{attr2}'/>"
                + "</root>";


        StringReader input = new StringReader( xml );
        Digester digester = new Digester();


        // Configure the digester as required
        HashMap<String, Object> source1 = new HashMap<String, Object>();
        source1.put( "attr1", "source1.attr1" );
        source1.put( "attr2", "source1.attr2" ); // should not be used


        HashMap<String, Object> source2 = new HashMap<String, Object>();
        source2.put( "attr1", "source2.attr1" ); // should not be used
        source2.put( "attr2", "source2.attr2" );


        MultiVariableExpander expander = new MultiVariableExpander();
        expander.addSource( "$", source1 );
        expander.addSource( "var", source2 );


        digester.setSubstitutor( new VariableSubstitutor( expander ) );
        digester.addObjectCreate( "root/bean", SimpleTestBean.class );
        digester.addSetProperties( "root/bean" );
        digester.addSetNext( "root/bean", "addSimpleTestBean" );


        // Parse our test input.
        this.simpleTestBeans.clear();
        digester.push( this );
        digester.parse( input );


        assertEquals( 2, this.simpleTestBeans.size() );


        {
            SimpleTestBean bean = this.simpleTestBeans.get( 0 );

View Full Code Here

    {


        String xml = "<root>" + "Twas noun{1} and the noun{2}" + " did verb{1} and verb{2} in the noun{3}" + "</root>";


        StringReader input = new StringReader( xml );
        Digester digester = new Digester();


        // Configure the digester as required
        HashMap<String, Object> nouns = new HashMap<String, Object>();
        nouns.put( "1", "brillig" );
        nouns.put( "2", "slithy toves" );
        nouns.put( "3", "wabe" );


        HashMap<String, Object> verbs = new HashMap<String, Object>();
        verbs.put( "1", "gyre" );
        verbs.put( "2", "gimble" );


        MultiVariableExpander expander = new MultiVariableExpander();
        expander.addSource( "noun", nouns );
        expander.addSource( "verb", verbs );
        digester.setSubstitutor( new VariableSubstitutor( expander ) );


        digester.addObjectCreate( "root", SimpleTestBean.class );
        digester.addCallMethod( "root", "setAlpha", 0 );


        // Parse our test input.
        SimpleTestBean root = digester.parse( input );


        assertNotNull( "Digester returned no object", root );


        assertEquals( "Twas brillig and the slithy toves" + " did gyre and gimble in the wabe", root.getAlpha() );
    }

View Full Code Here

0 1 2 3 4 5 6 7 8 9

TOP

Related Classes of org.apache.commons.digester3.CallMethodRule

eu.scape_project.planning.xml.PlanParser

hudson.plugins.analysis.util.ModuleDetector

hudson.plugins.dry.parser.AbstractDigesterParser

org.apache.commons.beanutils.converters.DateConverter

org.apache.commons.beanutils.DynaProperty

org.apache.commons.digester3.annotations.atom.Main

org.apache.commons.digester3.annotations.FromAnnotationsRuleModule

org.apache.commons.digester3.annotations.handlers.AbstractMethodHandler

org.apache.commons.digester3.BeanPropertySetterRuleTestCase

org.apache.commons.digester3.binder.AbstractRulesModule

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.