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.netbeans.modules.uml.common.generics.ETPairT;
045: import org.netbeans.modules.uml.core.support.umlutils.ETList;
046:
047: public interface IProductArchive {
048: /**
049: * Saves the archive to an XML file.
050: */
051: public boolean save(String sFilename);
052:
053: /**
054: * Loads the archive from the file
055: */
056: public boolean load(String sFilename);
057:
058: /**
059: * Checking if the archive file has been loaded.
060: *
061: * @return true if the file has been loaded.
062: */
063: public boolean isLoaded();
064:
065: /**
066: * Creates an element
067: */
068: public IProductArchiveElement createElement(String sID);
069:
070: /**
071: * Creates an element
072: */
073: public IProductArchiveElement createElement(String sID,
074: boolean bTopOfDocument);
075:
076: /**
077: * Gets an element based on the name
078: */
079: public IProductArchiveElement getElement(String sID);
080:
081: /**
082: * Returns all the presentation element types that refer to the IElement with an ID of sElementID
083: */
084: public ETList<IProductArchiveElement> getElementsFromModelElement(
085: String sElementID);
086:
087: /**
088: * All the toplevel elements
089: */
090: public ETList<IProductArchiveElement> getElements();
091:
092: /**
093: * Inserts an item into an index table and returns back the key and created element.
094: */
095: public ETPairT<IProductArchiveElement, Integer> insertIntoTable(
096: String sTableName, String sTableEntry);
097:
098: /**
099: * Inserts sTableEntry into the table sTableName and creates an attribute named sIndexAttributeName on pElementToAddIndexTo with the key value
100: */
101: public IProductArchiveAttribute insertIntoTable(String sTableName,
102: String sTableEntry, String sIndexAttributeName,
103: IProductArchiveElement pElementToAddIndexTo);
104:
105: /**
106: * Removes an item by index from the table.
107: */
108: public boolean removeFromTable(String sTableName, String sTableEntry);
109:
110: /**
111: * Based on the table name and index this routine returns the found element.
112: *
113: * @param sTableName The name of table that contains the entry.
114: * @param nTableEntry The entry to retrieve.
115: * @return The element from the table.
116: */
117: public IProductArchiveElement getTableEntry(String sTableName,
118: int nTableEntry);
119:
120: public IProductArchiveElement getTableEntry(String sTableName,
121: String nTableEntry);
122:
123: /**
124: * Gets an item from an index table, returning the key and the found element.
125: */
126: public IProductArchiveElement getTableEntry(String sTableName,
127: String sTableEntry, int pKey);
128:
129: /**
130: * Find sAttributeName in pArchiveElement, then look into the table sTableName and return the pFoundElement
131: */
132: public ETPairT<IProductArchiveElement, String> getTableEntry(
133: IProductArchiveElement pArchiveElement,
134: String sAttributeName, String sTableName);
135:
136: public ETList<IProductArchiveElement> getAllTableEntries(
137: String tableName);
138: }
|