001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.modules.uml.ui.support.archivesupport;
043:
044: import org.dom4j.Element;
045:
046: public interface IProductArchiveElement {
047: /**
048: * The name of the element.
049: */
050: public String getID();
051:
052: /**
053: * Creates a sub element.
054: */
055: public IProductArchiveElement createElement(String sID);
056:
057: /**
058: * Removes an attribute.
059: */
060: public void removeAttribute(String sID);
061:
062: /**
063: * Creates an attribute
064: */
065: public IProductArchiveAttribute addAttribute(String sName,
066: Object pVal);
067:
068: /**
069: * Creates an attribute
070: */
071: public IProductArchiveAttribute addAttributeLong(String sName,
072: long nVal);
073:
074: /**
075: * Creates an attribute
076: */
077: public IProductArchiveAttribute addAttributeBool(String sName,
078: boolean bVal);
079:
080: /**
081: * Creates an attribute
082: */
083: public IProductArchiveAttribute addAttributeDouble(String sName,
084: double fVal);
085:
086: /**
087: * Creates an attribute
088: */
089: public IProductArchiveAttribute addAttributeString(String sName,
090: String sVal);
091:
092: /**
093: * Gets all the sub elements of this element
094: */
095: public IProductArchiveElement[] getElements();
096:
097: /**
098: * Gets all the attributes of this element
099: */
100: public IProductArchiveAttribute[] getAttributes();
101:
102: /**
103: * Gets an attribute by name.
104: */
105: public IProductArchiveAttribute getAttribute(String sName);
106:
107: /**
108: * Gets an element by name.
109: */
110: public IProductArchiveElement getElement(String sID);
111:
112: /**
113: * Gets the IXMLDOMElement that matches this node.
114: */
115: public Element getDOMElement();
116:
117: /**
118: * Gets the IXMLDOMElement that matches this node.
119: */
120: public void setDOMElement(Element value);
121:
122: /**
123: * Gets an attribute value by name.
124: */
125: public long getAttributeLong(String sName);
126:
127: /**
128: * Gets an attribute value by name.
129: */
130: public String getAttributeString(String sName);
131:
132: /**
133: * Gets an attribute value by name.
134: */
135: public boolean getAttributeBool(String sName);
136:
137: /**
138: * Gets an attribute value by name.
139: */
140: public boolean getAttributeBool(String sName, boolean defaultValue);
141:
142: /**
143: * Gets an attribute value by name.
144: */
145: public double getAttributeDouble(String sName);
146:
147: /**
148: * Determines if the element has been deleted from the archive table.
149: *
150: * @return true if the element has been deleted.
151: */
152: public boolean isDeleted();
153:
154: }
|