com.feilong.lib.digester3.binder.LinkedRuleBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of feilong Show documentation
feilong is a suite of core and expanded libraries that include utility classes, http, excel,cvs, io classes, and much much more.
The newest version!
package com.feilong.lib.digester3.binder;

import com.feilong.lib.digester3.Rule;

/**
 * Builder invoked to bind one or more rules to a pattern.
 *
 * @since 3.0
 */
public final class LinkedRuleBuilder{

    private final RulesBinder       mainBinder;

    private final FromBinderRuleSet fromBinderRuleSet;

    private final ClassLoader       classLoader;

    private final String            keyPattern;

    private String                  namespaceURI;

    LinkedRuleBuilder(final RulesBinder mainBinder, final FromBinderRuleSet fromBinderRuleSet, final ClassLoader classLoader,
                    final String keyPattern){
        this.mainBinder = mainBinder;
        this.fromBinderRuleSet = fromBinderRuleSet;
        this.classLoader = classLoader;
        this.keyPattern = keyPattern;
    }

    /**
     * Construct rule that automatically sets a property from the body text, taking the property
     * name the same as the current element.
     *
     * @return a new {@link BeanPropertySetterBuilder} instance.
     */
    public BeanPropertySetterBuilder setBeanProperty(){
        return addProvider(new BeanPropertySetterBuilder(keyPattern, namespaceURI, mainBinder, this));
    }

    /**
     * Calls a method on an object on the stack (normally the top/parent object), passing arguments collected from
     * subsequent {@link #callParam()} rule or from the body of this element.
     *
     * @param methodName
     *            Method name of the parent object to call
     * @return a new {@link CallMethodBuilder} instance.
     */
    public CallMethodBuilder callMethod(String methodName){
        if (methodName == null || methodName.length() == 0){
            mainBinder.addError("{ forPattern( \"%s\" ).callMethod( String ) } empty 'methodName' not allowed", keyPattern);
        }

        return this.addProvider(new CallMethodBuilder(keyPattern, namespaceURI, mainBinder, this, methodName, classLoader));
    }

    /**
     * Saves a parameter for use by a surrounding {@link #callMethod(String)}.
     *
     * @return a new {@link CallParamBuilder} instance.
     */
    public CallParamBuilder callParam(){
        return this.addProvider(new CallParamBuilder(keyPattern, namespaceURI, mainBinder, this));
    }

    /**
     * Construct a "call parameter" rule that will save the body text of this element as the parameter value.
     *
     * @return a new {@link PathCallParamBuilder} instance.
     */
    public PathCallParamBuilder callParamPath(){
        return addProvider(new PathCallParamBuilder(keyPattern, namespaceURI, mainBinder, this));
    }

    /**
     * Uses an {@link com.feilong.lib.digester3.ObjectCreationFactory} to create a new object which it
     * pushes onto the object stack.
     *
     * When the element is complete, the object will be popped.
     *
     * @return a new {@link FactoryCreateBuilder} instance.
     */
    public FactoryCreateBuilder factoryCreate(){
        return addProvider(new FactoryCreateBuilder(keyPattern, namespaceURI, mainBinder, this, classLoader));
    }

    /**
     * Construct an object.
     *
     * @return a new {@link ObjectCreateBuilder} instance.
     */
    public ObjectCreateBuilder createObject(){
        return addProvider(new ObjectCreateBuilder(keyPattern, namespaceURI, mainBinder, this, classLoader));
    }

    /**
     * Saves a parameter for use by a surrounding {@link #callMethod(String)}.
     *
     * @param 
     *            The parameter type to pass along
     * @param paramObj
     *            The parameter to pass along
     * @return a new {@link ObjectParamBuilder} instance.
     */
    public  ObjectParamBuilder objectParam( /* @Nullable */T paramObj){
        return addProvider(new ObjectParamBuilder<>(keyPattern, namespaceURI, mainBinder, this, paramObj));
    }

    /**
     * Sets properties on the object at the top of the stack,
     * based on child elements with names matching properties on that object.
     *
     * @return a new {@link NestedPropertiesBuilder} instance.
     */
    public NestedPropertiesBuilder setNestedProperties(){
        // that would be useful when adding rules via automatically generated rules binding (such annotations)
        NestedPropertiesBuilder nestedPropertiesBuilder = fromBinderRuleSet
                        .getProvider(keyPattern, namespaceURI, NestedPropertiesBuilder.class);
        if (nestedPropertiesBuilder != null){
            return nestedPropertiesBuilder;
        }

        return addProvider(new NestedPropertiesBuilder(keyPattern, namespaceURI, mainBinder, this));
    }

    /**
     * Calls a method on the (top-1) (parent) object, passing the top object (child) as an argument,
     * commonly used to establish parent-child relationships.
     *
     * @param methodName
     *            Method name of the parent method to call
     * @return a new {@link SetNextBuilder} instance.
     */
    public SetNextBuilder setNext(String methodName){
        if (methodName == null || methodName.length() == 0){
            mainBinder.addError("{ forPattern( \"%s\" ).setNext( String ) } empty 'methodName' not allowed", keyPattern);
        }
        return this.addProvider(new SetNextBuilder(keyPattern, namespaceURI, mainBinder, this, methodName, classLoader));
    }

    /**
     * Sets properties on the object at the top of the stack, based on attributes with corresponding names.
     *
     * @return a new {@link SetPropertiesBuilder} instance.
     */
    public SetPropertiesBuilder setProperties(){
        // that would be useful when adding rules via automatically generated rules binding (such annotations)
        SetPropertiesBuilder setPropertiesBuilder = fromBinderRuleSet.getProvider(keyPattern, namespaceURI, SetPropertiesBuilder.class);
        if (setPropertiesBuilder != null){
            return setPropertiesBuilder;
        }

        return addProvider(new SetPropertiesBuilder(keyPattern, namespaceURI, mainBinder, this));
    }

    /**
     * Sets an individual property on the object at the top of the stack, based on attributes with specified names.
     *
     * @param attributePropertyName
     *            Name of the attribute that will contain the name of the property to be set
     * @return a new {@link SetPropertyBuilder} instance.
     */
    public SetPropertyBuilder setProperty(String attributePropertyName){
        if (attributePropertyName == null || attributePropertyName.length() == 0){
            mainBinder.addError("{ forPattern( \"%s\" ).setProperty( String ) } empty 'attributePropertyName' not allowed", keyPattern);
        }

        return addProvider(new SetPropertyBuilder(keyPattern, namespaceURI, mainBinder, this, attributePropertyName));
    }

    /**
     * Calls a method on the root object on the stack, passing the top object (child) as an argument.
     *
     * @param methodName
     *            Method name of the parent method to call
     * @return a new {@link SetRootBuilder} instance.
     */
    public SetRootBuilder setRoot(String methodName){
        if (methodName == null || methodName.length() == 0){
            mainBinder.addError("{ forPattern( \"%s\" ).setRoot( String ) } empty 'methodName' not allowed", keyPattern);
        }

        return addProvider(new SetRootBuilder(keyPattern, namespaceURI, mainBinder, this, methodName, classLoader));
    }

    /**
     * Calls a "set top" method on the top (child) object, passing the (top-1) (parent) object as an argument.
     *
     * @param methodName
     *            Method name of the "set parent" method to call
     * @return a new {@link SetTopBuilder} instance.
     */
    public SetTopBuilder setTop(String methodName){
        if (methodName == null || methodName.length() == 0){
            mainBinder.addError("{ forPattern( \"%s\" ).setTop( String ) } empty 'methodName' not allowed", keyPattern);
        }

        return addProvider(new SetTopBuilder(keyPattern, namespaceURI, mainBinder, this, methodName, classLoader));
    }

    /**
     * A rule implementation that creates a DOM Node containing the XML at the element that matched the rule.
     *
     * @return a new {@link NodeCreateRuleProvider} instance.
     */
    public NodeCreateRuleProvider createNode(){
        return addProvider(new NodeCreateRuleProvider(keyPattern, namespaceURI, mainBinder, this));
    }

    /**
     * Add a custom user rule in the specified pattern.
     *
     * WARNING keep away from this method as much as you can, since there's the risk
     * same input {@link Rule} instance is plugged to more than one Digester;
     * use {@link #addRuleCreatedBy(RuleProvider)} instead!!!
     *
     * @see #addRuleCreatedBy(RuleProvider)
     * @see Rule#setDigester(com.feilong.lib.digester3.Digester)
     * @param 
     *            The rule type
     * @param rule
     *            The custom user rule
     * @return a new {@link ByRuleBuilder} instance.
     */
    public  ByRuleBuilder addRule(R rule){
        if (rule == null){
            mainBinder.addError("{ forPattern( \"%s\" ).addRule( R ) } NULL rule not valid", keyPattern);
        }

        return this.addProvider(new ByRuleBuilder<>(keyPattern, namespaceURI, mainBinder, this, rule));
    }

    /**
     * Add a custom user rule in the specified pattern built by the given provider.
     *
     * @param 
     *            The rule type
     * @param provider
     *            The rule provider
     * @return a new {@link ByRuleProviderBuilder} instance.
     */
    public  ByRuleProviderBuilder addRuleCreatedBy(RuleProvider provider){
        if (provider == null){
            mainBinder.addError("{ forPattern( \"%s\" ).addRuleCreatedBy() } null rule provider not valid", keyPattern);
        }

        return addProvider(new ByRuleProviderBuilder<>(keyPattern, namespaceURI, mainBinder, this, provider));
    }

    /**
     * Sets the namespace URI for the current rule pattern.
     *
     * @param namespaceURI
     *            the namespace URI associated to the rule pattern.
     * @return this {@link LinkedRuleBuilder} instance
     */
    public LinkedRuleBuilder withNamespaceURI( /* @Nullable */String namespaceURI){
        if (namespaceURI == null || namespaceURI.length() > 0){
            this.namespaceURI = namespaceURI;
        }else{
            // ignore empty namespaces, null is better
            this.namespaceURI = null;
        }

        return this;
    }

    /**
     * Add a provider in the data structure where storing the providers binding.
     *
     * @param 
     *            The rule will be created by the given provider
     * @param provider
     *            The provider has to be stored in the data structure
     * @return The provider itself has to be stored in the data structure
     */
    private > RB addProvider(RB provider){
        fromBinderRuleSet.registerProvider(provider);
        return provider;
    }

}