KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > xml > schema > model > All


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */
19
20 package org.netbeans.modules.xml.schema.model;
21
22 import java.util.Collection JavaDoc;
23
24 /**
25  * This interface represents the xml schema all type. The all
26  * type describes an unordered group of elements.
27  * @author Chris Webster
28  */
29 public interface All extends ComplexExtensionDefinition, ComplexTypeDefinition,
30     LocalGroupDefinition,SchemaComponent {
31
32     public static final String JavaDoc ELEMENT_PROPERTY = "element"; //NOI18N
33 public static final String JavaDoc ELEMENT_REFERENCE_PROPERTY = "elementReference"; //NOI18N
34 public static final String JavaDoc MIN_OCCURS_PROPERTY = "minOccurs"; //NOI18N
35
36     
37     /**
38      * true if #getMinOccurs() allows optional multiplicity, false otherwise.
39      * This method is only accurate after the element has been inserted into the model.
40      */
41     boolean allowsFullMultiplicity();
42     
43         /**
44      * @return minimum occurrences, must be 0 <= x <= 1
45      */
46     Occur.ZeroOne getMinOccurs();
47     
48     /**
49      * set the minimum number of occurs.
50      * @param occurs must satisfy 0 <= occurs <= 1
51      */
52     void setMinOccurs(Occur.ZeroOne occurs);
53         
54         /**
55          * Returns default values for attribute minOccurs.
56          */
57         Occur.ZeroOne getMinOccursDefault();
58         
59         /**
60          * Returns the actual value set by user or default value if not set.
61          */
62         Occur.ZeroOne getMinOccursEffective();
63     
64     Collection JavaDoc<LocalElement> getElements();
65         void addElement(LocalElement element);
66         void removeElement(LocalElement element);
67     
68     Collection JavaDoc<ElementReference> getElementReferences();
69         void addElementReference(ElementReference element);
70         void removeElementReference(ElementReference element);
71 }
72
Popular Tags