Coverage Report

Coverage Report - org.melati.poem.DisplayLevel

Classes in this File

Line Coverage

Branch Coverage

Complexity

DisplayLevel

100%

19/19

100%

2/2

1.222

 /*
  * $Source$
  * $Revision$
  *
  * Copyright (C) 2000 William Chesters
  *
  * Part of Melati (http://melati.org), a framework for the rapid
  * development of clean, maintainable web applications.
  *
  * Melati is free software; Permission is granted to copy, distribute
  * and/or modify this software under the terms either:
  *
  * a) the GNU General Public License as published by the Free Software
  *    Foundation; either version 2 of the License, or (at your option)
  *    any later version,
  *
  *    or
  *
  * b) any version of the Melati Software License, as published
  *    at http://melati.org
  *
  * You should have received a copy of the GNU General Public License and
  * the Melati Software License along with this program;
  * if not, write to the Free Software Foundation, Inc.,
  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA to obtain the
  * GNU General Public License and visit http://melati.org to obtain the
  * Melati Software License.
  *
  * Feel free to contact the Developers of Melati (http://melati.org),
  * if you would like to work out a different arrangement than the options
  * outlined here.  It is our intention to allow Melati to be used by as
  * wide an audience as possible.
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * Contact details for copyright holder:
  *
  *     William Chesters <williamc At paneris.org>
  *     http://paneris.org/~williamc
  *     Obrechtstraat 114, 2517VX Den Haag, The Netherlands
  */
 
 package org.melati.poem;
 
 import java.util.Hashtable;
 
 /**
  * An attribute of a {@link Column} which indicates what level of 
  * reporting of a {@link Table} it should be included in.
  *
  */
 public final class DisplayLevel {
 
   /** The numeric Id of the Level. */
   public final Integer index;
   /** The name of the level. */
   private final String name;
 
   /** Constructor. */
   private DisplayLevel(int index, String name) {
     this.index = new Integer(index);
     this.name = name;
   }
   /**
    * @return the name
    */
   public String getName() {
     return name;
   }
 
   /**
    * @return the index.
    */
   public Integer getIndex() {
     return index;
   }
 
 
   /**
    * Display level of a {@link Column} used as the name of the 
    * whole record.
    *
    * @see Table#displayColumn()
    */
   public static final DisplayLevel primary;
 
   /**
    * Display level of {@link Column}s to be included in a summary of 
    * records in a set.
    * <p>
    * This is the default display level for a {@link Column}.
    *
    * @see Table#getSummaryDisplayColumns()
    * @see Column#defaultDisplayLevel()
    * @see Persistent#getSummaryDisplayFields()
    */
   public static final DisplayLevel summary;
 
   /**
    * Display level of {@link Column}s included in display focusing on a
    * single record, but without detail.
    *
    * @see Table#getRecordDisplayColumns()
    * @see Persistent#getRecordDisplayFields()
    */
   public static final DisplayLevel record;
 
   /**
    * Display level of {@link Column}s included in a detailed display
    * of a single record.
    *
    * @see Table#getRecordDisplayColumns()
    * @see Persistent#getDetailDisplayFields()
    */
   public static final DisplayLevel detail;
 
   /**
    * Display level of {@link Column}s hidden from users.
    */
   public static final DisplayLevel never;
 
   private static int n = 0;
 
   private static final DisplayLevel[] displayLevels =
     { primary = new DisplayLevel(n++, "primary"),
       summary = new DisplayLevel(n++, "summary"),
       record = new DisplayLevel(n++, "record"),
       detail = new DisplayLevel(n++, "detail"),
       never = new DisplayLevel(n++, "never") };
 
   private static final Hashtable<String, DisplayLevel> levelOfName = new Hashtable<String, DisplayLevel>();
 
   static {
     for (int i = 0; i < displayLevels.length; ++i)
       levelOfName.put(displayLevels[i].name, displayLevels[i]);
   }
 
   /**
    * Get by numeric id. 
    * 
    * @param index the numeric Id of the level
    * @return the level corresponding to the index
    */
   public static DisplayLevel forIndex(int index) {
     return displayLevels[index];
   }
 
   /**
    * @return the number of levels. 
    */
   public static int count() {
     return displayLevels.length;
   }
 
  /**
   * Thrown when a <code>DisplayLevel</code> which doesn't exist is referenced, 
   * by misspelling for example.
   */
   public static class NameUnrecognisedException extends PoemException {
     private static final long serialVersionUID = 1L;
 
     /** The name we did not recognise. */
     public String name;
 
     /** Constructor. */
     public NameUnrecognisedException(String name) {
       this.name = name;
     }
 
     /** @return The detail message. */
     public String getMessage() {
       return "No display level found which goes by the name `" + name + "'";
     }
   }
 
   /**
    * Get by name. 
    * @param name The name of the required level
    * @return the named level
    */
   public static DisplayLevel named(String name) {
     DisplayLevel it = (DisplayLevel)levelOfName.get(name);
     if (it == null)
       throw new NameUnrecognisedException(name);
     return it;
   }
   
   /** 
    * @return the name and index.
    * {@inheritDoc}
    * @see java.lang.Object#toString()
    */
   public String toString() {
     return name + "/" + index;
   }
 }

1		/*
2		* $Source$
3		* $Revision$
4		*
5		* Copyright (C) 2000 William Chesters
6		*
7		* Part of Melati (http://melati.org), a framework for the rapid
8		* development of clean, maintainable web applications.
9		*
10		* Melati is free software; Permission is granted to copy, distribute
11		* and/or modify this software under the terms either:
12		*
13		* a) the GNU General Public License as published by the Free Software
14		* Foundation; either version 2 of the License, or (at your option)
15		* any later version,
16		*
17		* or
18		*
19		* b) any version of the Melati Software License, as published
20		* at http://melati.org
21		*
22		* You should have received a copy of the GNU General Public License and
23		* the Melati Software License along with this program;
24		* if not, write to the Free Software Foundation, Inc.,
25		* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA to obtain the
26		* GNU General Public License and visit http://melati.org to obtain the
27		* Melati Software License.
28		*
29		* Feel free to contact the Developers of Melati (http://melati.org),
30		* if you would like to work out a different arrangement than the options
31		* outlined here. It is our intention to allow Melati to be used by as
32		* wide an audience as possible.
33		*
34		* This program is distributed in the hope that it will be useful,
35		* but WITHOUT ANY WARRANTY; without even the implied warranty of
36		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
37		* GNU General Public License for more details.
38		*
39		* Contact details for copyright holder:
40		*
41		* William Chesters <williamc At paneris.org>
42		* http://paneris.org/~williamc
43		* Obrechtstraat 114, 2517VX Den Haag, The Netherlands
44		*/
45
46		package org.melati.poem;
47
48		import java.util.Hashtable;
49
50		/**
51		* An attribute of a {@link Column} which indicates what level of
52		* reporting of a {@link Table} it should be included in.
53		*
54		*/
55		public final class DisplayLevel {
56
57		/** The numeric Id of the Level. */
58		public final Integer index;
59		/** The name of the level. */
60		private final String name;
61
62		/** Constructor. */
63	5	private DisplayLevel(int index, String name) {
64	5	this.index = new Integer(index);
65	5	this.name = name;
66	5	}
67		/**
68		* @return the name
69		*/
70		public String getName() {
71	1	return name;
72		}
73
74		/**
75		* @return the index.
76		*/
77		public Integer getIndex() {
78	185	return index;
79		}
80
81
82		/**
83		* Display level of a {@link Column} used as the name of the
84		* whole record.
85		*
86		* @see Table#displayColumn()
87		*/
88		public static final DisplayLevel primary;
89
90		/**
91		* Display level of {@link Column}s to be included in a summary of
92		* records in a set.
93		* <p>
94		* This is the default display level for a {@link Column}.
95		*
96		* @see Table#getSummaryDisplayColumns()
97		* @see Column#defaultDisplayLevel()
98		* @see Persistent#getSummaryDisplayFields()
99		*/
100		public static final DisplayLevel summary;
101
102		/**
103		* Display level of {@link Column}s included in display focusing on a
104		* single record, but without detail.
105		*
106		* @see Table#getRecordDisplayColumns()
107		* @see Persistent#getRecordDisplayFields()
108		*/
109		public static final DisplayLevel record;
110
111		/**
112		* Display level of {@link Column}s included in a detailed display
113		* of a single record.
114		*
115		* @see Table#getRecordDisplayColumns()
116		* @see Persistent#getDetailDisplayFields()
117		*/
118		public static final DisplayLevel detail;
119
120		/**
121		* Display level of {@link Column}s hidden from users.
122		*/
123		public static final DisplayLevel never;
124
125	1	private static int n = 0;
126
127	1	private static final DisplayLevel[] displayLevels =
128		{ primary = new DisplayLevel(n++, "primary"),
129		summary = new DisplayLevel(n++, "summary"),
130		record = new DisplayLevel(n++, "record"),
131		detail = new DisplayLevel(n++, "detail"),
132		never = new DisplayLevel(n++, "never") };
133
134	1	private static final Hashtable<String, DisplayLevel> levelOfName = new Hashtable<String, DisplayLevel>();
135
136		static {
137	6	for (int i = 0; i < displayLevels.length; ++i)
138	5	levelOfName.put(displayLevels[i].name, displayLevels[i]);
139	1	}
140
141		/**
142		* Get by numeric id.
143		*
144		* @param index the numeric Id of the level
145		* @return the level corresponding to the index
146		*/
147		public static DisplayLevel forIndex(int index) {
148	180	return displayLevels[index];
149		}
150
151		/**
152		* @return the number of levels.
153		*/
154		public static int count() {
155	933	return displayLevels.length;
156		}
157
158		/**
159		* Thrown when a <code>DisplayLevel</code> which doesn't exist is referenced,
160		* by misspelling for example.
161		*/
162		public static class NameUnrecognisedException extends PoemException {
163		private static final long serialVersionUID = 1L;
164
165		/** The name we did not recognise. */
166		public String name;
167
168		/** Constructor. */
169		public NameUnrecognisedException(String name) {
170		this.name = name;
171		}
172
173		/** @return The detail message. */
174		public String getMessage() {
175		return "No display level found which goes by the name `" + name + "'";
176		}
177		}
178
179		/**
180		* Get by name.
181		* @param name The name of the required level
182		* @return the named level
183		*/
184		public static DisplayLevel named(String name) {
185	3	DisplayLevel it = (DisplayLevel)levelOfName.get(name);
186	3	if (it == null)
187	1	throw new NameUnrecognisedException(name);
188	2	return it;
189		}
190
191		/**
192		* @return the name and index.
193		* {@inheritDoc}
194		* @see java.lang.Object#toString()
195		*/
196		public String toString() {
197	1	return name + "/" + index;
198		}
199		}