View Javadoc

1   /**
2   The contents of this file are subject to the Mozilla Public License Version 1.1 
3   (the "License"); you may not use this file except in compliance with the License. 
4   You may obtain a copy of the License at http://www.mozilla.org/MPL/ 
5   Software distributed under the License is distributed on an "AS IS" basis, 
6   WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 
7   specific language governing rights and limitations under the License. 
8   
9   The Original Code is "Structure.java".  Description: 
10  "Part of an HL7 message: either a segment or group" 
11  
12  The Initial Developer of the Original Code is University Health Network. Copyright (C) 
13  2001.  All Rights Reserved. 
14  
15  Contributor(s): ______________________________________. 
16  
17  Alternatively, the contents of this file may be used under the terms of the 
18  GNU General Public License (the "GPL"), in which case the provisions of the GPL are 
19  applicable instead of those above.  If you wish to allow use of your version of this 
20  file only under the terms of the GPL and not to allow others to use your version 
21  of this file under the MPL, indicate your decision by deleting  the provisions above 
22  and replace  them with the notice and other provisions required by the GPL License.  
23  If you do not delete the provisions above, a recipient may use your version of 
24  this file under either the MPL or the GPL. 
25  
26  */
27  
28  package ca.uhn.hl7v2.model;
29  
30  import java.io.Serializable;
31  
32  import ca.uhn.hl7v2.HL7Exception;
33  
34  /**
35   * Part of an HL7 message: either a segment or group.  There are certain methods (e.g. Group.get())
36   * that will always return either a segment or a group.  This interface allows methods like this
37   * to declare a return type of Structure instead of Object. 
38   *  
39   * @author Bryan Tripp (bryan_tripp@sourceforge.net)
40   */
41  public interface Structure extends Serializable {
42  
43    /**
44     * Returns the Message object to which this structure belongs.  This should normally be set at
45     * construction time.  A Structure can only belong to a single Message.  This is primarily 
46     * to avoid a situation where intended changes in one message cause unintended changes 
47     * in another that shares one of the same Structure objects.  
48     */
49    public Message getMessage();
50  
51    /**
52     * Returns the structure's name. 
53     */
54    public String getName(); 
55    
56    /**
57     * Returns the parent group within which this structure exists (may be root 
58     * message group).  
59     */
60    public Group getParent();
61    
62    /**
63     * @return <code>true</code> if the structure is not populated
64     */
65    public boolean isEmpty() throws HL7Exception;
66    
67  }