summaryrefslogtreecommitdiff
path: root/ooxml/source/framework/SchemaParser/src/org/apache/openoffice/ooxml/schema/model/complex/OccurrenceIndicator.java
blob: dcc41bfbb7ce304d2d07bd77eb8ed035c32fc561 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
/**************************************************************
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements.  See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership.  The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License.  You may obtain a copy of the License at
*
*   http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied.  See the License for the
* specific language governing permissions and limitations
* under the License.
*
*************************************************************/

package org.apache.openoffice.ooxml.schema.model.complex;

import org.apache.openoffice.ooxml.schema.model.base.INodeVisitor;
import org.apache.openoffice.ooxml.schema.model.base.Location;
import org.apache.openoffice.ooxml.schema.model.base.Node;
import org.apache.openoffice.ooxml.schema.model.base.NodeType;

/** An occurrence indicator is based on a minimum and a maximum value.
 *  The minimum value is 0 or larger.  If it is 0 then the child node is optional.
 *  The maximum value is at least as large as the minimum value.
 *  It can be 'unbounded' in which case the child node can appear any number of times.
 *  'Unbounded' is internally stored as -1.
 *
 *  An OccurrenceIndicator represents the minOccur and maxOccur attributes of
 *  XML schema elements.
 *
 *  There is usually exactly one child.
 */
public class OccurrenceIndicator
    extends Node
{
    public static int unbounded = -1;

    public OccurrenceIndicator (
        final Node aParent,
        final String sMinimum,
        final String sMaximum,
        final Location aLocation)
    {
        super(aParent, null, aLocation);

        mnMinimum = ParseValue(sMinimum);
        mnMaximum = ParseValue(sMaximum);

        assert(mnMinimum>=0);
        assert(mnMaximum==unbounded || mnMaximum>=mnMinimum);
    }




    @Override
    public NodeType GetNodeType ()
    {
        return NodeType.OccurrenceIndicator;
    }




    /** Return a string version of the minimum value for textual display.
     */
    public String GetDisplayMinimum ()
    {
        return Integer.toString(mnMinimum);
    }




    /** Return a string version of the maximum value for textual display.
     */
    public String GetDisplayMaximum ()
    {
        if (mnMaximum == unbounded)
            return "unbounded";
        else
            return Integer.toString(mnMaximum);
    }




    public int GetMinimum ()
    {
        return mnMinimum;
    }




    public int GetMaximum ()
    {
        return mnMaximum;
    }




    @Override
    public void AcceptVisitor (final INodeVisitor aVisitor)
    {
        aVisitor.Visit(this);
    }




    @Override
    public String toString ()
    {
        return String.format("occurrence %s to %s",
            GetDisplayMinimum(),
            GetDisplayMaximum());
    }




    private static int ParseValue (final String sValue)
    {
        if (sValue == null)
        {
            // Missing values default to 1.
            return 1;
        }
        else
            switch (sValue)
            {
                case "0" : return 0;
                case "1" : return 1;
                case "unbounded" : return unbounded;
                default: return Integer.parseInt(sValue);
            }
    }



    private final int mnMinimum;
    private final int mnMaximum;
}