overviewdoc.java

可以实现UDDI

/*
 * The source code contained herein is licensed under the IBM Public License
 * Version 1.0, which has been approved by the Open Source Initiative.
 * Copyright (C) 2001, International Business Machines Corporation
 * All Rights Reserved.
 *
 */

package org.uddi4j.datatype;

import java.util.Vector;

import org.uddi4j.UDDIElement;
import org.uddi4j.UDDIException;
import org.w3c.dom.Element;
import org.w3c.dom.NodeList;

/**
 * Represents the overviewDoc element within the UDDI version 2.0 schema.
 * This class contains the following types of methods:
 * 
 * <ul>
 *   <li>Constructor passing the required fields.
 *   <li>Constructor that will instantiate the object from an appropriate XML
 *       DOM element.
 *   <li>Get/set methods for each attribute that this element can contain.
 *   <li>For sets of attributes, a get/setVector method is provided.
 *   <li>SaveToXML method. Serializes this class within a passed in element.
 * </ul>
 * 
 * Typically this class is used to construct parameters for, or interpret
 * responses from methods in the UDDIProxy class.
 *
 * <p><b>Element description:</b>
 * <p>Support element - used to contain an on-line description and a
 * URL pointer to additional in-depth or external documentation.
 *
 * 
 * @author David Melgar ([e-mail])
 */
public class OverviewDoc extends UDDIElement {

   public static final String UDDI_TAG = "overviewDoc";

   protected Element base = null;

   OverviewURL overviewURL = null;
   // Vector of Description objects
   Vector description = new Vector();

  /**
    * Default constructor.
    * Avoid using the default constructor for validation. It does not validate
    * required fields. Instead, use the required fields constructor to perform
    * validation.
    */
   public OverviewDoc() {
   }

   /**
    * Construct the object from a DOM tree. Used by
    * UDDIProxy to construct an object from a received UDDI
    * message.
    *
    * @param base   Element with name appropriate for this class.
    *
    * @exception UDDIException Thrown if DOM tree contains a SOAP fault or
    *  disposition report indicating a UDDI error.
    */
   public OverviewDoc(Element base) throws UDDIException {
      // Check if it is a fault. Throw exception if it is a fault.
      super(base);
      NodeList nl = null;
      nl = getChildElementsByTagName(base, OverviewURL.UDDI_TAG);
      if (nl.getLength() > 0) {
         overviewURL = new OverviewURL((Element)nl.item(0));
      }
      nl = getChildElementsByTagName(base, Description.UDDI_TAG);
      for (int i=0; i < nl.getLength(); i++) {
         description.addElement(new Description((Element)nl.item(i)));
      }
   }

   public void setOverviewURL(OverviewURL s) {
      overviewURL = s;
   }
   public void setOverviewURL(String s) {
      overviewURL = new OverviewURL();
      overviewURL.setText(s);
   }

   /**
    * Set a description vector.
    *
    * @param s  Vector of <I>Description</I> objects.
    */
   public void setDescriptionVector(Vector s) {
      description = s;
   }

   /**
    * Set default (english) description string.
    *
    * @param s  String
    */
   public void setDefaultDescriptionString(String s) {
      if (description.size() > 0) {
         description.setElementAt(new Description(s), 0);
      } else {
         description.addElement(new Description(s));
      }
   }

   public OverviewURL getOverviewURL() {
      return overviewURL;
   }

   public String getOverviewURLString() {
   	  if (overviewURL != null) {
		 return overviewURL.getText();   	  	
   	  } else {
   	  	 return null;
   	  }      
   }

   /**
    * Get description.
    *
    * @return s Vector of <I>Description</I> objects.
    */
   public Vector getDescriptionVector() {
      return description;
   }

   /**
    * Get default description string.
    *
    * @return s String
    */
   public String getDefaultDescriptionString() {
      if ((description).size() > 0) {
         Description t = (Description)description.elementAt(0);
         return t.getText();
      } else {
         return null;
      }
   }

   /**
    * Save the object to a DOM tree. Used to serialize an object
    * to a DOM tree, usually to send a UDDI message.
    *
    * <BR>Used by UDDIProxy.
    *
    * @param parent Object will serialize as a child element under the
    *               passed in parent element.
    */
   public void saveToXML(Element parent) {
      base = parent.getOwnerDocument().createElementNS(UDDIElement.XMLNS, UDDIElement.XMLNS_PREFIX + UDDI_TAG);
      // Save attributes
      if (description!=null) {
        for (int i=0; i < description.size(); i++) {
           ((Description)(description.elementAt(i))).saveToXML(base);
        }
      }
      if (overviewURL!=null) {
         overviewURL.saveToXML(base);
      }
      parent.appendChild(base);
   }
   
   
   public boolean equals(Object object)
   {
   		boolean result = false;
   		if (object != null && object instanceof OverviewDoc)
   		{
			OverviewDoc otherOverviewDoc = (OverviewDoc)object;
			if ((this.description == null && otherOverviewDoc.description == null)
				|| (this.description != null && this.description.equals(otherOverviewDoc.description)))
			{
				//description matches
				if ((this.overviewURL == null && otherOverviewDoc.overviewURL == null)
					|| (this.overviewURL != null && this.overviewURL.equals(otherOverviewDoc.overviewURL)))
				{
					//overviewURL matches as well.
					result = true;
				}
				//else overviewURL does not match - result it false.				
			}
			//else description does not match - result is false.   		
   		}   		
   		return result;  	   	
   }
}