View Javadoc

1   /*
2    * Copyright 2007 - 2007 JEuclid, http://jeuclid.sf.net
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.w3c.dom.mathml;
17  
18  /*
19   * Please note: This file was automatically generated from the source of the
20   * MathML specification. Do not edit it. If there are errors or missing
21   * elements, please correct the stylesheet instead.
22   */
23  
24  /**
25   * The declare construct has two primary roles. The first is to change or set
26   * the default attribute values for a specific mathematical object. The second
27   * is to establish an association between a name and an object.
28   * 
29   * 
30   */
31  public interface MathMLDeclareElement extends MathMLContentElement {
32      /**
33       * A string indicating the type of the identifier. It must be compatible
34       * with the type of the constructor, if a constructor is present. The type
35       * is inferred from the constructor if present, otherwise it must be
36       * specified.
37       * 
38       * @return value of the type attribute.
39       */
40      String getType();
41  
42      /**
43       * setter for the type attribute.
44       * 
45       * @param type
46       *            new value for type.
47       * @see #getType()
48       */
49      void setType(String type);
50  
51      /**
52       * If the identifier is a function, this attribute specifies the number of
53       * arguments the function takes. This represents the declare element's
54       * nargs attribute; see .
55       * 
56       * @return value of the nargs attribute.
57       */
58      int getNargs();
59  
60      /**
61       * setter for the nargs attribute.
62       * 
63       * @param nargs
64       *            new value for nargs.
65       * @see #getNargs()
66       */
67      void setNargs(int nargs);
68  
69      /**
70       * A string with the values prefix, infix, postfix, or function-model.
71       * 
72       * @return value of the occurrence attribute.
73       */
74      String getOccurrence();
75  
76      /**
77       * setter for the occurrence attribute.
78       * 
79       * @param occurrence
80       *            new value for occurrence.
81       * @see #getOccurrence()
82       */
83      void setOccurrence(String occurrence);
84  
85      /**
86       * A URI specifying the detailed semantics of the element.
87       * 
88       * @return value of the definitionURL attribute.
89       */
90      String getDefinitionURL();
91  
92      /**
93       * setter for the definitionURL attribute.
94       * 
95       * @param definitionURL
96       *            new value for definitionURL.
97       * @see #getDefinitionURL()
98       */
99      void setDefinitionURL(String definitionURL);
100 
101     /**
102      * A description of the syntax used in definitionURL.
103      * 
104      * @return value of the encoding attribute.
105      */
106     String getEncoding();
107 
108     /**
109      * setter for the encoding attribute.
110      * 
111      * @param encoding
112      *            new value for encoding.
113      * @see #getEncoding()
114      */
115     void setEncoding(String encoding);
116 
117     /**
118      * A MathMLCiElement representing the name being declared.
119      * 
120      * @return value of the identifier attribute.
121      */
122     MathMLCiElement getIdentifier();
123 
124     /**
125      * setter for the identifier attribute.
126      * 
127      * @param identifier
128      *            new value for identifier.
129      * @see #getIdentifier()
130      */
131     void setIdentifier(MathMLCiElement identifier);
132 
133     /**
134      * An optional MathMLElement providing an initial value for the object
135      * being declared.
136      * 
137      * @return value of the constructor attribute.
138      */
139     MathMLElement getConstructor();
140 
141     /**
142      * setter for the constructor attribute.
143      * 
144      * @param constructor
145      *            new value for constructor.
146      * @see #getConstructor()
147      */
148     void setConstructor(MathMLElement constructor);
149 };