ws/dst/DSTQueryItem.java

a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Copyright (c) 2006 Sun Microsystems Inc. All Rights Reserved
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The contents of this file are subject to the terms
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * of the Common Development and Distribution License
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * (the License). You may not use this file except in
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * compliance with the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * You can obtain a copy of the License at
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * https://opensso.dev.java.net/public/CDDLv1.0.html or
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * opensso/legal/CDDLv1.0.txt
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * See the License for the specific language governing
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * permission and limitations under the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * When distributing Covered Code, include this CDDL
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Header Notice in each file and include the License file
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * at opensso/legal/CDDLv1.0.txt.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * If applicable, add the following below the CDDL Header,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * with the fields enclosed by brackets [] replaced by
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * your own identifying information:
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * "Portions Copyrighted [year] [name of copyright owner]"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * $Id: DSTQueryItem.java,v 1.2 2008/06/25 05:47:13 qcheng Exp $
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpackage com.sun.identity.liberty.ws.dst;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport java.text.ParseException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport java.util.Date;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport java.util.StringTokenizer;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.shared.DateUtils;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.shared.xml.XMLUtils;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport org.w3c.dom.NodeList;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport org.w3c.dom.Element;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The class <code>DSTQueryItem</code> is the wrapper for one query item
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * for Data service.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The following schema fragment specifies the expected content within the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>DSTQueryItem</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <pre>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * &lt;element name="QueryItem" maxOccurs="unbounded">
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *   &lt;complexType>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *     &lt;complexContent>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *       &lt;restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *         &lt;sequence>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *           &lt;element name="Select"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *           type="{urn:liberty:id-sis-pp:2003-08}SelectType"/>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *         &lt;/sequence>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *         &lt;attribute name="itemID"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *         type="{urn:liberty:id-sis-pp:2003-08}IDType" />
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *         &lt;attribute name="changedSince"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *         type="{http://www.w3.org/2001/XMLSchema}dateTime" />
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *         &lt;attribute name="includeCommonAttributes"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *         type="{http://www.w3.org/2001/XMLSchema}boolean" />
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *         &lt;attribute name="id"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *         type="{http://www.w3.org/2001/XMLSchema}ID" />
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *       &lt;/restriction>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *     &lt;/complexContent>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *   &lt;/complexType>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * &lt;/element>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * </pre>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @supported.all.api
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpublic class DSTQueryItem {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private String select;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private boolean includeCommonAttribute;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private Date changedSince;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private String itemID = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private String id = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private String nameSpaceURI = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private String prefix = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Constructor
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param select specifies the data the query  should return
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param serviceNS service Name space
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public DSTQueryItem (String select, String serviceNS) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        this.select = select;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        this.nameSpaceURI = serviceNS;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Constructor
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param select specifies the data the query  should return
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param includeCommonAttribute if true, query response will
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *        contains common attributes (attribute id and modification
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *        time)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param changedSince Only match entries changed after the specified
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *        date
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param serviceNS service Name space
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public DSTQueryItem (String select,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                         boolean includeCommonAttribute,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                         Date changedSince,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                         String serviceNS) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        this.select = select;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        this.includeCommonAttribute = includeCommonAttribute;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        this.changedSince = changedSince;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        this.nameSpaceURI = serviceNS;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Constructor
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param element <code>DOM</code> Element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @throws DSTException
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public DSTQueryItem(org.w3c.dom.Element element) throws DSTException{
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if(element == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           DSTUtils.debug.error("DSTQueryItem(element):null input");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           throw new DSTException(DSTUtils.bundle.getString("nullInputParams"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        String elementName = element.getLocalName();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if(elementName == null || !elementName.equals("QueryItem")) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           DSTUtils.debug.error("DSTQueryItem(element):Invalid elementName");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           throw new DSTException(DSTUtils.bundle.getString("invalidElement"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        nameSpaceURI = element.getNamespaceURI();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if(nameSpaceURI == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           DSTUtils.debug.error("DSTQueryItem(element): Namespace is null");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           throw new DSTException(DSTUtils.bundle.getString("noNameSpace"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        prefix = element.getPrefix();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        id = element.getAttribute("id");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        String attr = element.getAttribute("includeCommonAttributes");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if(attr != null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           includeCommonAttribute = Boolean.valueOf(attr).booleanValue();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        attr = element.getAttribute("changedSince");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (attr != null && attr.length() != 0) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            try {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                changedSince = DateUtils.stringToDate(attr);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            } catch(ParseException ex) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                DSTUtils.debug.error(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                    "DSTQueryItem(element): date can not be parsed.", ex);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        NodeList list = element.getElementsByTagNameNS(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        nameSpaceURI, "Select");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if((list.getLength() != 1)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           DSTUtils.debug.error("DSTQueryItem(element): Select is null" +
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           " or more than one select found.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           throw new DSTException(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           DSTUtils.bundle.getString("invalidSelect"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        select = XMLUtils.getElementValue((Element)list.item(0));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if(select == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           DSTUtils.debug.error("DSTQueryItem(element): Select is null" );
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           throw new DSTException(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           DSTUtils.bundle.getString("invalidSelect"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns data selection string
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return String
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public String getSelect() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return select;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Gets <code>itemID</code> attribute
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return String
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public String getItemID() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return itemID;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Sets <code>itemID</code> attribute
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param itemID item ID to be set
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     public void setItemID(String itemID) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster         this.itemID = itemID;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Gets id attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return id attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public String getId() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return id;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Sets id attribute
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param id id attribute to be set
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public void setId(String id) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        this.id = id;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Checks include common attribute for the <code>DST</code> query item.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return boolean
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public boolean isIncludeCommonAttributes() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return includeCommonAttribute;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster   /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    * Gets changed since attribute
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    * @return Date
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public Date getChangedSince() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return changedSince;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Gets the name space.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return Name space.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public java.lang.String getNameSpaceURI() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return nameSpaceURI;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Sets the name space.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param nameSpace Name space URI.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public void setNameSpaceURI(String nameSpace) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        this.nameSpaceURI = nameSpace;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Sets the name space prefix.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param prefix Name space prefix.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public void setNameSpacePrefix(String prefix) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        this.prefix = prefix;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Gets the name space prefix.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return String Name space prefix.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public java.lang.String getNameSpacePrefix() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return prefix;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Creates a String representation of this object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * By default name space name is prepended to the element name
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return String A string containing the valid XML for this element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public java.lang.String toString() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return toString(true, false);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Creates a String representation of this object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param includeNS if true prepends all elements by their Name space prefix
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param declareNS if true includes the Name space within the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *                  generated.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return String A string containing the valid XML for this element
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public java.lang.String toString(boolean includeNS, boolean declareNS) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if(select == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           DSTUtils.debug.error("DSTQueryItem.toString: Select cannot be null");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           return "";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        String tempPrefix = "";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if(includeNS) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           if(prefix == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster              prefix = DSTConstants.DEFAULT_NS_PREFIX;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           tempPrefix = prefix + ":";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (declareNS && nameSpaceURI == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            DSTUtils.debug.error("DSTQueryItem.toString: Name Space is " +
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster              "not defined");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            return "";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        StringBuffer sb = new StringBuffer(300);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        sb.append("<").append(tempPrefix).append("QueryItem");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if(id != null && id.length() != 0) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           sb.append(" id=\"").append(id).append("\"");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        sb.append(" includeCommonAttributes=\"");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if(includeCommonAttribute) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           sb.append("true").append("\"");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        } else {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           sb.append("false").append("\"");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if(itemID != null && itemID.length() != 0) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           sb.append(" itemID=\"").append(itemID).append("\"");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (changedSince != null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            sb.append(" changedSince=\"")
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                .append(DateUtils.toUTCDateFormat(changedSince))
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                .append("\"");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if(declareNS) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           sb.append(" xmlns:").append(prefix).append("=\"")
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster             .append(nameSpaceURI).append("\"")
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster             .append(" xmlns=\"").append(nameSpaceURI).append("\"");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        sb.append(">").append("<").append(tempPrefix).append("Select")
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster          .append(">").append(appendPrefix(select, prefix)).append("</")
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster          .append(tempPrefix).append("Select").append(">")
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster          .append("</").append(tempPrefix).append("QueryItem").append(">");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return sb.toString();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    private String appendPrefix(String select, String prefix) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if(select.indexOf(":") != -1) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           // prefix is already defined.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           return select;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        StringBuffer sb = new StringBuffer(100);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        StringTokenizer st = new StringTokenizer(select, "/");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        while(st.hasMoreTokens()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           String temp = (String)st.nextToken();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           temp = "/" + prefix + ":" + temp;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           sb.append(temp);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return sb.toString();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster}