Class SchemaComponent

    • Constructor Detail

      • SchemaComponent

        public SchemaComponent()
        Creates a new unnamed schema component.
      • SchemaComponent

        public SchemaComponent​(Atom atom)
        Creates a new named schema component.
        Parameters:
        atom - The name.
    • Method Detail

      • usesPropIndex

        public final boolean usesPropIndex()
        Schema properties use index.
        Specified by:
        usesPropIndex in interface IPropCnr
        Overrides:
        usesPropIndex in class PropCnr
        Returns:
        true if index is used, false for non-index based container.
      • setName

        public final void setName​(javax.xml.namespace.QName qname)
        Names the property.
        Parameters:
        qname - The name.
      • getName

        public final javax.xml.namespace.QName getName()
        Gets the Type name.
        Returns:
        The QName, or null if not defined.
      • getName

        public final javax.xml.namespace.QName getName​(IMessageBuilder messageBuilder)
                                                throws javax.xml.soap.SOAPException
        Gets the Type name. The name is prefixed using the message builder.
        Parameters:
        messageBuilder - The message builder.
        Returns:
        The QName, or null if not defined.
        Throws:
        javax.xml.soap.SOAPException - If the name is in error.
      • getLocalName

        public final java.lang.String getLocalName()
        Gets the local name.
        Returns:
        The name, or null if not defined.
      • getElementID

        public java.lang.String getElementID()
        Gets the ID of the schema element.
        Returns:
        null if not specified, otherwise the ID.
      • setInt

        public void setInt​(java.lang.String name,
                           java.math.BigInteger bigInteger)
        Sets a BigInteger value to a maximized int value. If the value is null, the IntProp("name") is not set.
        Parameters:
        name - The IntProp name.
        bigInteger - The BigInteger to read, null for none.
      • getBaseName

        protected java.lang.String getBaseName​(SchemaComponent comp)
        Gets the base name for multiple schema components of a certain type. Override to provide support for multiple schema components to be added.
        Parameters:
        comp - Component to rename.
        Returns:
        The base name for the property to rename it, or null to skip rename.
      • addComponent

        public final void addComponent​(SchemaComponent comp)
                                throws BuildSchemaException
        Adds a schema component. This method can be overridden to support renaming of schema components.
        Parameters:
        comp - Component to add.
        Throws:
        BuildSchemaException - If the properties cannot be built.
      • addComponent

        public final void addComponent​(SchemaComponent comp,
                                       java.lang.String base)
                                throws BuildSchemaException
        Adds a schema component. This method can be overridden to support renaming of schema components.
        Parameters:
        comp - Component to add.
        base - Base name for rename.
        Throws:
        BuildSchemaException - If the properties cannot be built.
      • buildMessage

        public abstract void buildMessage​(IMessageBuilder messageBuilder,
                                          javax.xml.soap.SOAPElement parent,
                                          javax.xml.soap.SOAPElement current,
                                          boolean isProduction)
                                   throws PropException,
                                          javax.xml.soap.SOAPException
        Builds the SOAP message to send it.
        Parameters:
        messageBuilder - The message builder.
        parent - The parent element.
        current - The current element, null if not already created.
        isProduction - Flag indicating the data is "production data" as opposed to sample/template.
        Throws:
        PropException - For build error of a property.
        javax.xml.soap.SOAPException - For SOAP errors.