attributetypeinfodto.java

电子地图服务器,搭建自己的地图服务

/* Copyright (c) 2001 - 2007 TOPP - www.openplans.org.  All rights reserved.
 * This code is licensed under the GPL 2.0 license, availible at the root
 * application directory.
 */
package org.vfny.geoserver.global.dto;

import java.util.logging.Logger;


/**
 * Represents most of a xs:element for an XMLSchema.
 *
 * <p>
 * we have three types of information to store, Schema defined types,
 * references and extentions on types. If the type represented is either  a
 * reference or a Schema defined type  then isRef should be true.
 * </p>
 *
 * <p>
 * Non-complex types are of the form:
 * </p>
 *
 * <ul>
 * <li>
 * <code>{element name='test' type='xs:string'/}</code>
 * </li>
 * <li>
 * <code>{element name='test' type='gml:PointType'/}</code>
 * </li>
 * </ul>
 *
 * <p>
 * For complex types such as  <code>{element
 * name='test'}{xs:complexContent}{xs:extension
 * base="gml:AbstractFeatureType"}{xs:sequence}{xs:element name="id"
 * type="xs:string" minOccurs="0"/}{xs:element ref="gml:pointProperty"
 * minOccurs="0"/}{/xs:sequence}{/xs:extension}{/xs:complexContent}{/element}</code>
 * The type contains a similar XML fragment.
 * </p>
 *
 * <p>
 * minOccurs, maxOccurs and nillable are all attributes for all cases. There is
 * more stuff in the XMLSchema spec but we don't care.
 * </p>
 *
 * @author dzwiers, Refractions Research, Inc.
 * @version $Id: AttributeTypeInfoDTO.java 7746 2007-11-13 15:38:35Z aaime $
 */
public class AttributeTypeInfoDTO implements DataTransferObject {
    /** For debugging */
    private static final Logger LOGGER = org.geotools.util.logging.Logging.getLogger("org.vfny.geoserver.global.dto");

    /** attribute name */
    private String name;

    /** attribute min occurs */
    private int minOccurs = 0;

    /** attribute max occurs */
    private int maxOccurs = 1;

    /** true when nillable */
    private boolean nillable = true;

    /**
     * if is ref and a name is specified, then treat like a simple type (same
     * thing ...) otherwise this is a complex type.
     */
    private String type;

    /**
     * This is true when type is complex.
     *
     * <p>
     * This is used to denote that type proerty is an XML fragment, rather than
     * type a type declaration. type declaration must be from
     * GMLUtils.xmlSchemaType or gmlTypes but not baseGMLTypes.
     * </p>
     *
     * <p>
     * baseGMLTypes can only be used in your XML fragment.
     * </p>
     */
    private boolean isComplex = false;

    /**
     * AttributeTypeInfoDTO constructor, see DataTransferObjectFactory.
     *
     * <p>
     * Default constructor, does nothing
     * </p>
     */
    public AttributeTypeInfoDTO() {
    }

    /**
     * AttributeTypeInfoDTO constructor, see DataTransferObjectFactory.
     *
     * <p>
     * Copies the data from the specified DTO to this one.
     * </p>
     *
     * @param dto AttributeTypeInfoDTO The data source to copy from.
     */
    public AttributeTypeInfoDTO(AttributeTypeInfoDTO dto) {
        name = dto.getName();
        type = dto.getType();
        minOccurs = dto.getMinOccurs();
        maxOccurs = dto.getMaxOccurs();
        nillable = dto.isNillable();
        isComplex = dto.isComplex();
    }

    /**
     * Implement equals.
     *
     * <p>
     * true when the data contained inside the objects is the same.
     * </p>
     *
     * @param obj an instance of AttributeTypeInfoDTO to compare
     *
     * @return true when they are the same, false otherwise
     *
     * @see java.lang.Object#equals(java.lang.Object)
     */
    public boolean equals(Object obj) {
        boolean r = true;

        if ((obj == null) || !(obj instanceof AttributeTypeInfoDTO)) {
            return false;
        }

        AttributeTypeInfoDTO dto = (AttributeTypeInfoDTO) obj;
        r = r && (name == dto.getName());
        r = r && (type == dto.getType());
        r = r && (minOccurs == dto.getMinOccurs());
        r = r && (maxOccurs == dto.getMaxOccurs());
        r = r && (nillable == dto.isNillable());
        r = r && (isComplex == dto.isComplex());

        return r;
    }

    /**
     * Implement hashCode.
     *
     * <p>
     * The hashcode for this object.
     * </p>
     *
     * @return a hashcode value.
     *
     * @see java.lang.Object#hashCode()
     */
    public int hashCode() {
        return name.hashCode() * type.hashCode();
    }

    /**
     * Implement clone.
     *
     * <p>
     * An instance of AttributeTypeInfoDTO which is the same as this one.
     * </p>
     *
     * @return Object a copy of this object.
     *
     * @see java.lang.Object#clone()
     */
    public Object clone() {
        AttributeTypeInfoDTO dto = new AttributeTypeInfoDTO();
        dto.setMaxOccurs(maxOccurs);
        dto.setMinOccurs(minOccurs);
        dto.setName(name);
        dto.setNillable(nillable);
        dto.setComplex(isComplex);
        dto.setType(type);

        return dto;
    }

    /**
     * isRef purpose.
     *
     * <p>
     * Returns is this is a reference element type or a document defined type.
     * </p>
     *
     * @return true when either a ref or XMLSchema type.
     */
    public boolean isComplex() {
        return isComplex;
    }

    /**
     * getMaxOccurs purpose.
     *
     * <p>
     * The max number of occurences for this element.
     * </p>
     *
     * @return max number of occurences
     */
    public int getMaxOccurs() {
        return maxOccurs;
    }

    /**
     * getMinOccurs purpose.
     *
     * <p>
     * the min number of occurences for this element
     * </p>
     *
     * @return min number of occurences
     */
    public int getMinOccurs() {
        return minOccurs;
    }

    /**
     * getName purpose.
     *
     * <p>
     * returns the element name
     * </p>
     *
     * @return the element name
     */
    public String getName() {
        return name;
    }

    /**
     * isNillable purpose.
     *
     * <p>
     * Description ...
     * </p>
     *
     * @return
     */
    public boolean isNillable() {
        return nillable;
    }

    /**
     * getType purpose.
     *
     * <p>
     * returns the element type. This is an XML fragment if isRef() returns
     * false.
     * </p>
     *
     * @return the element type. This is an XML fragment if isRef() returns
     *         false.
     */
    public String getType() {
        return type;
    }

    /**
     * setRef purpose.
     *
     * <p>
     * Sets whether this is a reference type element or not
     * </p>
     *
     * @param b true when this is a reference type element.
     */
    public void setComplex(boolean b) {
        isComplex = b;
    }

    /**
     * setMaxOccurs purpose.
     *
     * <p>
     * Stores the max occurs for the element
     * </p>
     *
     * @param i the max occurs for the element
     */
    public void setMaxOccurs(int i) {
        maxOccurs = i;
    }

    /**
     * setMinOccurs purpose.
     *
     * <p>
     * Stores the min occurs for the element
     * </p>
     *
     * @param i the min occurs for the element
     */
    public void setMinOccurs(int i) {
        minOccurs = i;
    }

    /**
     * setName purpose.
     *
     * <p>
     * Stores the name for the element
     * </p>
     *
     * @param string the name for the element
     */
    public void setName(String string) {
        name = string;
    }

    /**
     * setNillable purpose.
     *
     * <p>
     * Stores if this element is nillable
     * </p>
     *
     * @param b true when this element is nillable
     */
    public void setNillable(boolean b) {
        nillable = b;
    }

    /**
     * setType purpose.
     *
     * <p>
     * Stores the type for this element. This is an XML fragment when isRef()
     * returns false.
     * </p>
     *
     * @param string type for this element. This is an XML fragment when
     *        isRef() returns false.
     */
    public void setType(String string) {
        type = string;
    }

    public String toString() {
        return "[AttributeTypeInfoDTO " + name + " minOccurs=" + minOccurs + " maxOccurs="
        + maxOccurs + " nillable=" + nillable + " type=" + type + " isComplex=" + isComplex + "]";
    }
}