Package org.jibx.binding.model

Class IncludeElement

java.lang.Object
org.jibx.binding.model.ElementBase
org.jibx.binding.model.NestingElementBase
org.jibx.binding.model.IncludeElement
public class IncludeElement extends NestingElementBase
Model component for include element of binding definition. During prevalidation this reads the included binding definition. All further processing of the included components needs to be handled directly by the tree walking code in TreeContext, since the components of the included binding need to be treated as though they were direct children of the container of this element (and accessed in the appropriate order).
Author:
Dennis M. Sosnoski

  • Field Details

    • s_allowedAttributes

      public static final StringArray s_allowedAttributes
      Enumeration of allowed attribute names

    • m_includePath

      private String m_includePath
      Path to included binding definition.

    • m_precompiled

      private boolean m_precompiled
      Included binding precompiled flag.

    • m_binding

      private BindingElement m_binding
      Object model for included binding.

  • Constructor Details

    • IncludeElement

      public IncludeElement()
      Constructor.

  • Method Details

    • setIncludePath

      public void setIncludePath(String path)
      Set path to included binding.
      Parameters:
      path -

    • getIncludePath

      public String getIncludePath()
      Get path to included binding.
      Returns:
      path

    • getBinding

      public BindingElement getBinding()
      Get the included binding model. This call is only valid after prevalidation.
      Returns:
      binding element, or null if redundant include

    • isPrecompiled

      public boolean isPrecompiled()
      Check if precompiled binding.
      Returns:
      true if precompiled, false if not

    • setPrecompiled

      public void setPrecompiled(boolean precomp)
      Set precompiled binding flag.
      Parameters:
      precomp -

    • preSet

      private void preSet(IUnmarshallingContext uctx) throws JiBXException
      Make sure all attributes are defined.
      Parameters:
      uctx - unmarshalling context
      Throws:
      JiBXException - on unmarshalling error

    • prevalidate

      public void prevalidate(ValidationContext vctx)
      Description copied from class: ElementBase
      Prevalidate element information. The prevalidation step is used to check isolated aspects of an element, such as the settings for enumerated values on the element and attributes. This empty base class implementation should be overridden by each subclass that requires prevalidation handling.
      Overrides:
      prevalidate in class NestingElementBase
      Parameters:
      vctx - validation context