root/org.axdt.axdoc/src/org/axdt/axdoc/model/AXIndexNode.java @ 9a9ef10dfc3b0467e14e06261fda3654c5aced64

Revision 9a9ef10dfc3b0467e14e06261fda3654c5aced64, 4.0 KB (checked in by Martin Schnabel <mb0@…>, 16 months ago)

initial commit.
axdoc emf model with tests and asdoc parser.
(asdoc parsing is not 100% functional yet)
  • Property mode set to 100644
Line 
1/**
2 * EPL - axdt.org
3 * created by martin schnabel - mb0
4 *
5 * $Id$
6 */
7package org.axdt.axdoc.model;
8
9import org.eclipse.emf.common.util.EList;
10import org.eclipse.emf.ecore.EObject;
11
12/**
13 * <!-- begin-user-doc -->
14 * A representation of the model object '<em><b>AX Index Node</b></em>'.
15 * <!-- end-user-doc -->
16 *
17 * <p>
18 * The following features are supported:
19 * <ul>
20 *   <li>{@link org.axdt.axdoc.model.AXIndexNode#getName <em>Name</em>}</li>
21 *   <li>{@link org.axdt.axdoc.model.AXIndexNode#getEntries <em>Entries</em>}</li>
22 *   <li>{@link org.axdt.axdoc.model.AXIndexNode#getId <em>Id</em>}</li>
23 *   <li>{@link org.axdt.axdoc.model.AXIndexNode#getBasicParent <em>Basic Parent</em>}</li>
24 * </ul>
25 * </p>
26 *
27 * @see org.axdt.axdoc.AXDocPackage#getAXIndexNode()
28 * @model abstract="true"
29 * @generated
30 */
31public interface AXIndexNode extends EObject {
32        /**
33         * Returns the value of the '<em><b>Name</b></em>' attribute.
34         * <!-- begin-user-doc -->
35         * <p>
36         * If the meaning of the '<em>Name</em>' attribute isn't clear,
37         * there really should be more of a description here...
38         * </p>
39         * <!-- end-user-doc -->
40         * @return the value of the '<em>Name</em>' attribute.
41         * @see #setName(String)
42         * @see org.axdt.axdoc.AXDocPackage#getAXIndexNode_Name()
43         * @model required="true"
44         * @generated
45         */
46        String getName();
47
48        /**
49         * Sets the value of the '{@link org.axdt.axdoc.model.AXIndexNode#getName <em>Name</em>}' attribute.
50         * <!-- begin-user-doc -->
51         * <!-- end-user-doc -->
52         * @param value the new value of the '<em>Name</em>' attribute.
53         * @see #getName()
54         * @generated
55         */
56        void setName(String value);
57
58        /**
59         * Returns the value of the '<em><b>Entries</b></em>' containment reference list.
60         * The list contents are of type {@link org.axdt.axdoc.model.AXEntry}.
61         * It is bidirectional and its opposite is '{@link org.axdt.axdoc.model.AXEntry#getParent <em>Parent</em>}'.
62         * <!-- begin-user-doc -->
63         * <p>
64         * If the meaning of the '<em>Entries</em>' containment reference list isn't clear,
65         * there really should be more of a description here...
66         * </p>
67         * <!-- end-user-doc -->
68         * @return the value of the '<em>Entries</em>' containment reference list.
69         * @see org.axdt.axdoc.AXDocPackage#getAXIndexNode_Entries()
70         * @see org.axdt.axdoc.model.AXEntry#getParent
71         * @model opposite="parent" containment="true" keys="id"
72         * @generated
73         */
74        EList<AXEntry> getEntries();
75
76        /**
77         * Returns the value of the '<em><b>Id</b></em>' attribute.
78         * <!-- begin-user-doc -->
79         * <p>
80         * If the meaning of the '<em>Id</em>' attribute isn't clear,
81         * there really should be more of a description here...
82         * </p>
83         * <!-- end-user-doc -->
84         * @return the value of the '<em>Id</em>' attribute.
85         * @see org.axdt.axdoc.AXDocPackage#getAXIndexNode_Id()
86         * @model id="true" transient="true" changeable="false" derived="true"
87         * @generated
88         */
89        String getId();
90
91        /**
92         * Returns the value of the '<em><b>Basic Parent</b></em>' reference.
93         * <!-- begin-user-doc -->
94         * <p>
95         * If the meaning of the '<em>Basic Parent</em>' reference isn't clear,
96         * there really should be more of a description here...
97         * </p>
98         * <!-- end-user-doc -->
99         * @return the value of the '<em>Basic Parent</em>' reference.
100         * @see org.axdt.axdoc.AXDocPackage#getAXIndexNode_BasicParent()
101         * @model transient="true" changeable="false" volatile="true"
102         * @generated
103         */
104        AXIndexNode getBasicParent();
105
106        /**
107         * <!-- begin-user-doc -->
108         * <!-- end-user-doc -->
109         * @model kind="operation"
110         * @generated
111         */
112        AXRoot getRoot();
113
114        /**
115         * <!-- begin-user-doc -->
116         * <!-- end-user-doc -->
117         * @model
118         * @generated
119         */
120        String fullUrl();
121
122        /**
123         * <!-- begin-user-doc -->
124         * <!-- end-user-doc -->
125         * @model
126         * @generated
127         */
128        EList<AXEntry> localEntry(String part);
129
130        /**
131         * <!-- begin-user-doc -->
132         * <!-- end-user-doc -->
133         * @model
134         * @generated
135         */
136        AXEntry localEntry(String part, boolean member);
137
138        /**
139         * <!-- begin-user-doc -->
140         * <!-- end-user-doc -->
141         * @model
142         * @generated
143         */
144        AXEntry createEntry(String part, AXEntryType type);
145
146} // AXIndexNode
Note: See TracBrowser for help on using the browser.