/* $Id: XmiReader.java 17747 2010-01-10 21:16:51Z linus $
*******************************************************************************
* Copyright (c) 2009 Contributors - see below
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* tfmorris
*******************************************************************************
*
* Some portions of this file was previously release using the BSD License:
*/
// Copyright (c) 1996-2008 The Regents of the University of California. All
// Rights Reserved. Permission to use, copy, modify, and distribute this
// software and its documentation without fee, and without a written
// agreement is hereby granted, provided that the above copyright notice
// and this paragraph appear in all copies. This software program and
// documentation are copyrighted by The Regents of the University of
// California. The software program and documentation are supplied "AS
// IS", without any accompanying services from The Regents. The Regents
// does not warrant that the operation of the program will be
// uninterrupted or error-free. The end-user understands that the program
// was developed for research purposes and is advised not to rely
// exclusively on the program for any reason. IN NO EVENT SHALL THE
// UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
// SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
// ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
// THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
// SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
// PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
// CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
// UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
package org.argouml.model;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import org.xml.sax.InputSource;
/**
* XMI file reader to deserialize a model into the model repository.
* <p>
* @author Bob Tarling
*/
public interface XmiReader {
/* Implementation Note:
* Unlike many of the interfaces to the model there is no control to force
* a single instance of an XmiReader. This is to allow work objects generated
* by the implementation to be garbage collected when an XmiReader instance
* falls out of scope.
*/
/**
* Parse a given inputsource to a collection of top level model elements.
*
* @param pIs
* the input source for parsing
* @param readOnly
* true if the resulting model is to be treated as read-only.
* It not be written back out when the model data is written.
* @return a collection of top level elements
* @throws UmlException
* on any error
* @since 0.22
*/
Collection parse(InputSource pIs, boolean readOnly) throws UmlException;
/**
* Get the map of external IDs to UML elements. For earlier versions of
* ArgoUML, the id was the xmi.uuid, but currently it is the xmi.id. These
* are unique within a given XMI file, but no attempt is made to make them
* globally unique. They are, however, guaranteed to remain stable across
* load/save cycles, so they can be used for external cross-references (e.g.
* from the PGML diagram files).
*
* @return the map
*/
Map<String, Object> getXMIUUIDToObjectMap();
/**
* Set the list of element names for which errors should be ignored when
* reading the XMI file. The common one is "UML:Diagram" but it can be
* any element which is not in the metamodel.<p>
*
* This may not be supported by all implementations. The method will
* return false if unsupported.
*
* @param elementNames array of element names which reader should ignore
* @return returns false if the operation is unsupported
*/
public boolean setIgnoredElements(String[] elementNames);
/**
* Returns list of element names which will be ignored during XMI import
* if they cause an error.
*
* @return array of names (Strings)
*/
public String[] getIgnoredElements();
/**
* Return the count of elements read during the last XMI read which were on
* the ignore list.
*
* @return the count
*/
public int getIgnoredElementCount();
/**
* Return the name of the outermost tag in the XMI file.
*
* @return the tag name
*/
public String getTagName();
/**
* Get the list of paths to be searched when looking for XMI files to
* resolve external references with. The list is maintained in a static
* structure shared by all instances.
*
* @return a List of directory paths
*/
public List<String> getSearchPath();
/**
* Add a path to the list of paths to be searched when looking for XMI files
* to resolve external references with. The list is maintained in a static
* structure shared by all instances.
* <p>
* TODO: It's desirable to have separate search paths for separate files,
* but more work is required in ArgoUML so that it knows how to maintain
* separate contexts for the profiles and user models.
*
* @param path
* a directory path to add to the search path
*/
public void addSearchPath(String path);
/**
* Remove a path from the list of paths to be searched when looking for XMI
* files to resolve external references with. The list is maintained in a
* static structure shared by all instances.
*
* @param path
* directory path to remove from search
*/
public void removeSearchPath(String path);
/**
* Get the header comment from the XMI file, if any. The comment is
* contained in the <XMI.header> element. The contents are optional
* and may vary from one UML tool to the other. ArgoUML writes a
* string similar to the following:
* <pre>
* <XMI.documentation>
* <XMI.exporter>
* ArgoUML (using Netbeans XMI Writer version 1.0)
* </XMI.exporter>
* <XMI.exporterVersion>
* 1.4 revised on $Date: 2010-01-10 22:16:51 +0100 (So, 10 Jan 2010) $
* </XMI.exporterVersion>
* </XMI.documentation>
* <XMI.metamodel xmi.name = 'UML' xmi.version = '1.4'/>
* </pre>
* @return A String containing the XML fragment
*/
public String getHeader();
}