Package org.zkoss.bind.impl

Class ValidationContextImpl

  • All Implemented Interfaces:
    ValidationContext
    public class ValidationContextImpl
extends java.lang.Object
implements ValidationContext
    the default implementation of validation context
    Since:
    6.0.0
    Author:
    dennis

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      BindContext getBindContext()  
      java.lang.String getCommand()
      get the command that trigger the validation
      java.util.Map<java.lang.String,​Property[]> getProperties()
      get dependent properties that need to be validated.
      java.util.Map<java.lang.String,​Property> getProperties​(java.lang.Object base)
      get dependent properties by a base object.
      Property[] getProperties​(java.lang.String name)
      get dependent properties by the property name.
      Property getProperty()
      get the main property that need to be validated.
      java.lang.Object getValidatorArg​(java.lang.String key)
      Returns validator arg value of the given key This is a shortcut of getBindContext().getValidatorArg()
      boolean isLocalValid()
      Checks status of local validation context valid or not, it only relates to one validator.
      boolean isValid()
      Checks status of validation context valid or not, it is a global status of same command, any validator of this validation phase call ValidationContext.setInvalid() will set this false.
      void setInvalid()
      set invalid

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ValidationContextImpl

        public ValidationContextImpl​(java.lang.String command,
                             Property property,
                             java.util.Map<java.lang.String,​Property[]> properties,
                             BindContext ctx,
                             boolean valid)

    • Method Detail

      • getCommand

        public java.lang.String getCommand()
        Description copied from interface: ValidationContext
        get the command that trigger the validation
        Specified by:
        getCommand in interface ValidationContext
        Returns:
        the command, null if a prompt-save-binding

      • getProperties

        public java.util.Map<java.lang.String,​Property[]> getProperties()
        Description copied from interface: ValidationContext
        get dependent properties that need to be validated. you usually use this method to get value of other properties to do complex validation or a form validation Notice that if the property is under a collection, you would see "$each", which represents "each"
        Specified by:
        getProperties in interface ValidationContext
        Returns:
        the properties map.

      • getProperties

        public Property[] getProperties​(java.lang.String name)
        Description copied from interface: ValidationContext
        get dependent properties by the property name. you usually use this method to get a value of other properties to do complex validation or a form validation Notice that if the property is under a collection, you would see "$each", which represents "each"
        Specified by:
        getProperties in interface ValidationContext
        Parameters:
        name - the property name
        Returns:
        the properties array

      • getProperties

        public java.util.Map<java.lang.String,​Property> getProperties​(java.lang.Object base)
        Description copied from interface: ValidationContext
        get dependent properties by a base object. this method returns a Map (key is the property name) of properties that have same base object. It is useful in the form validation case to get all dependent property that related to a form. For example in a validator of a form, 
        
 Map<String,Property> beanProps = ctx.getProperties(ctx.getProperty().getBase());
 Map<String,Property> formProps = ctx.getProperties(ctx.getProperty().getValue());
        Notice that if the property is under a collection, you would see "$each", which represents "each"
        Specified by:
        getProperties in interface ValidationContext
        Parameters:
        base - the base object of properties
        Returns:
        a Map of properties that has same base object.

      • getValidatorArg

        public java.lang.Object getValidatorArg​(java.lang.String key)
        Description copied from interface: ValidationContext
        Returns validator arg value of the given key This is a shortcut of getBindContext().getValidatorArg()
        Specified by:
        getValidatorArg in interface ValidationContext
        Parameters:
        key - the key to the value.
        Returns:
        value of validator arg of the given key

      • getProperty

        public Property getProperty()
        Description copied from interface: ValidationContext
        get the main property that need to be validated. Notice that if the property is under a collection, you would see "$each", which represents "each"
        Specified by:
        getProperty in interface ValidationContext
        Returns:
        the main property.