XmlSchema/src/main/java/org/apache/ws/commons/schema/extensions/ExtensionDeserializer.java

/*
 * Copyright 2004,2007 The Apache Software Foundation.
 * Portions Copyright 2006 International Business Machines Corp.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.ws.commons.schema.extensions;

import org.apache.ws.commons.schema.XmlSchemaObject;
import org.w3c.dom.Node;

import javax.xml.namespace.QName;

/**
 * Interface for the extension deserializer. The purpose of an instance
 * of this is to deserialize the relevant attribute/element and perhaps generate
 * a desired custom object. This custom object can be stored in the metadata map
 * of the parent schema object. When to invoke a given deserializer is a decision
 * taken by the extension registry
 */
public interface ExtensionDeserializer {

    /**
     * deserialize the given element
     * @param schemaObject  - Parent schema element
     * @param name - the QName of the element/attribute to be deserialized.
     * in the case where a deserializer is used to handle multiple elements/attributes
     * this may be useful to determine the correct deserialization
     * @param domNode - the raw DOM Node read from the source. This will be the
     * extension element itself if for an element or the extension attribute object if
     * it is an attribute
     *
     */
    public void deserialize(XmlSchemaObject schemaObject,
                            QName name,
                            Node domNode);

}