001/**
002 * The contents of this file are subject to the Mozilla Public License Version 1.1
003 * (the "License"); you may not use this file except in compliance with the License.
004 * You may obtain a copy of the License at http://www.mozilla.org/MPL/
005 * Software distributed under the License is distributed on an "AS IS" basis,
006 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the
007 * specific language governing rights and limitations under the License.
008 *
009 * The Original Code is "Field.java".  Description:
010 * Auxilliary model class encapsulating field repetitions and substructures
011 *
012 * The Initial Developer of the Original Code is University Health Network. Copyright (C)
013 * 2001-2013.  All Rights Reserved.
014 *
015 * Contributor(s): ______________________________________.
016 *
017 * Alternatively, the contents of this file may be used under the terms of the
018 * GNU General Public License (the  �GPL�), in which case the provisions of the GPL are
019 * applicable instead of those above.  If you wish to allow use of your version of this
020 * file only under the terms of the GPL and not to allow others to use your version
021 * of this file under the MPL, indicate your decision by deleting  the provisions above
022 * and replace  them with the notice and other provisions required by the GPL License.
023 * If you do not delete the provisions above, a recipient may use your version of
024 * this file under either the MPL or the GPL.
025 *
026 */
027package ca.uhn.hl7v2.model;
028
029import ca.uhn.hl7v2.HL7Exception;
030import ca.uhn.hl7v2.Location;
031
032/**
033 * Field is a auxiliary model class only created while visiting parts of the
034 * message.
035 */
036public class Field implements Visitable {
037
038    private Type[] reps;
039    private int maxCardinality;
040    
041    
042    public Field(Type[] reps, int maxCardinality) {
043        super();
044        this.reps = reps;
045        this.maxCardinality = maxCardinality;
046    }
047
048    public boolean accept(MessageVisitor visitor, Location currentLocation) throws HL7Exception {
049        if (visitor.start(this, currentLocation)) {
050            for (int i=0; i < reps.length; i++) {
051                Type t = reps[i];
052                if (!t.accept(visitor, currentLocation))
053                    break;
054            }
055        }
056        return visitor.end(this, currentLocation);
057    }
058
059    public Location provideLocation(Location parentLocation, int index, int repetition) {
060        return new Location(parentLocation).withField(index);
061    }
062
063    public boolean isEmpty() throws HL7Exception {
064        return reps.length == 0;
065    }
066
067}