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.core.support.umlutils;
043:
044: import org.dom4j.Document;
045: import org.dom4j.Node;
046: import java.util.Vector;
047:
048: public interface IPropertyDefinitionFactory {
049: /**
050: * Get or create a property definition matching the type or the dispatch kind passed in
051: */
052: public IPropertyDefinition getPropertyDefinitionForElement(
053: String eleName, Object pDisp);
054:
055: /**
056: * Initialize the factory
057: */
058: public void initialize();
059:
060: /**
061: * Retrieve a particular method from an already built map
062: */
063: public Object getFromFunctionMap(Object pDisp, String methName,
064: String[] parmTypes);
065:
066: /**
067: * Retrieve documentation information from an already built map based on Object type
068: */
069: public void getFromElementTypeDocMap(Object pDisp, String pVal);
070:
071: /**
072: * Gets the xml file that defines the property definitions
073: */
074: public String getDefinitionFile();
075:
076: /**
077: * Gets the xml file that defines the property definitions
078: */
079: public void setDefinitionFile(String value);
080:
081: /**
082: * Based on the already set definition file, build all definitions within the file
083: */
084: public Vector<IPropertyDefinition> buildDefinitionsUsingFile();
085:
086: /**
087: * Gets the xml document that defines the property definitions
088: */
089: public Document getXMLDocument();
090:
091: /**
092: * Gets the xml document that defines the property definitions
093: */
094: public void setXMLDocument(Document value);
095:
096: /**
097: * Get or create a property definition matching the name passed in
098: */
099: public IPropertyDefinition getPropertyDefinitionByName(String name);
100:
101: /**
102: * Build a definition given the xml node
103: */
104: public IPropertyDefinition buildDefinitionFromNode(Node pNode);
105:
106: /**
107: * Build a definition given a string
108: */
109: public IPropertyDefinition buildDefinitionFromString(String str);
110:
111: }
|