001: /*
002: * Copyright (c) 1998-2008 Caucho Technology -- all rights reserved
003: *
004: * This file is part of Resin(R) Open Source
005: *
006: * Each copy or derived work must preserve the copyright notice and this
007: * notice unmodified.
008: *
009: * Resin Open Source is free software; you can redistribute it and/or modify
010: * it under the terms of the GNU General Public License as published by
011: * the Free Software Foundation; either version 2 of the License, or
012: * (at your option) any later version.
013: *
014: * Resin Open Source is distributed in the hope that it will be useful,
015: * but WITHOUT ANY WARRANTY; without even the implied warranty of
016: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
017: * of NON-INFRINGEMENT. See the GNU General Public License for more
018: * details.
019: *
020: * You should have received a copy of the GNU General Public License
021: * along with Resin Open Source; if not, write to the
022: *
023: * Free Software Foundation, Inc.
024: * 59 Temple Place, Suite 330
025: * Boston, MA 02111-1307 USA
026: *
027: * @author Scott Ferguson
028: */
029:
030: package com.caucho.relaxng.program;
031:
032: import com.caucho.relaxng.RelaxException;
033: import com.caucho.relaxng.pattern.ElementPattern;
034: import com.caucho.util.L10N;
035: import com.caucho.xml.QName;
036:
037: import java.util.HashSet;
038: import java.util.Iterator;
039:
040: /**
041: * Generates programs from patterns.
042: */
043: public class ElementItem extends Item {
044: protected final static L10N L = new L10N(ElementItem.class);
045:
046: private ElementPattern _element;
047:
048: private NameClassItem _nameItem;
049: private Item _item;
050: private Item _childrenItem;
051:
052: public ElementItem(ElementPattern element, NameClassItem nameItem) {
053: _element = element;
054: _nameItem = nameItem;
055: }
056:
057: public NameClassItem getNameClassItem() {
058: return _nameItem;
059: }
060:
061: public void setChildrenItem(Item item) {
062: _childrenItem = item;
063: }
064:
065: /**
066: * Returns the first set, the set of element names possible.
067: */
068: public void firstSet(HashSet<QName> set) {
069: _nameItem.firstSet(set);
070: }
071:
072: /**
073: * Returns the first set, the set of element names possible.
074: */
075: public void requiredFirstSet(HashSet<QName> set) {
076: _nameItem.firstSet(set);
077: }
078:
079: /**
080: * The element does not allow the empty match.
081: */
082: public boolean allowEmpty() {
083: return false;
084: }
085:
086: /**
087: * Return all possible child items or null
088: */
089: public Iterator<Item> getItemsIterator() {
090: if (_item == null) {
091: _item = InElementItem.create(_childrenItem, EmptyItem
092: .create());
093: }
094:
095: return itemIterator(_item);
096: }
097:
098: /**
099: * Returns the next item on the match.
100: *
101: * @param name the name of the element
102: */
103: public Item startElement(QName name) throws RelaxException {
104: if (!_nameItem.matches(name))
105: return null;
106:
107: if (_item == null) {
108: _item = InElementItem.create(_childrenItem, EmptyItem
109: .create());
110: }
111:
112: return _item;
113: }
114:
115: /**
116: * Returns true if the element is allowed somewhere in the item.
117: * allowsElement is used for error messages to give more information
118: * in cases of order dependency.
119: *
120: * @param name the name of the element
121: *
122: * @return true if the element is allowed somewhere
123: */
124: public boolean allowsElement(QName name) {
125: return _nameItem.matches(name);
126: }
127:
128: /**
129: * Returns the pretty printed syntax.
130: */
131: public String toSyntaxDescription(int depth) {
132: return _nameItem.toSyntaxDescription("");
133: }
134:
135: /**
136: * Returns true for an element with simple syntax.
137: */
138: protected boolean isSimpleSyntax() {
139: return true;
140: }
141:
142: /**
143: * Returns the hash code for the empty item.
144: */
145: public int hashCode() {
146: return 87 + _element.getDefName().hashCode();
147: }
148:
149: /**
150: * Returns true if the object is an empty item.
151: */
152: public boolean equals(Object o) {
153: if (this == o)
154: return true;
155:
156: if (!(o instanceof ElementItem))
157: return false;
158:
159: ElementItem elt = (ElementItem) o;
160:
161: return _element.getDefName().equals(elt._element.getDefName());
162: }
163:
164: public String toString() {
165: return "ElementItem[" + _nameItem + "]";
166: }
167: }
|