View Javadoc

1   /*--------------------------------------------------------------------------
2    *  Copyright 2007 utgenome.org
3    *
4    *  Licensed under the Apache License, Version 2.0 (the "License");
5    *  you may not use this file except in compliance with the License.
6    *  You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   *  Unless required by applicable law or agreed to in writing, software
11   *  distributed under the License is distributed on an "AS IS" BASIS,
12   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   *  See the License for the specific language governing permissions and
14   *  limitations under the License.
15   *--------------------------------------------------------------------------*/
16  //--------------------------------------
17  // GenomeBrowser Project
18  //
19  // TrackGroupProperty.java
20  // Since: Jun 12, 2007
21  //
22  // $URL$ 
23  // $Author$
24  //--------------------------------------
25  package org.utgenome.gwt.utgb.client.track;
26  
27  import java.util.Set;
28  
29  import org.utgenome.gwt.utgb.client.util.xml.XMLWriter;
30  
31  /**
32   * {@link TrackGroupProperty} is an interface to read property values defined in a {@link TrackGroup}
33   * 
34   * @author leo
35   * 
36   */
37  public interface TrackGroupProperty {
38  	/**
39  	 * get a property value of a given key
40  	 * 
41  	 * @param key
42  	 * @return a property value of a given key
43  	 */
44  	public String getProperty(String key);
45  
46  	/**
47  	 * @return the key set of properties
48  	 */
49  	public Set<String> keySet();
50  
51  	/**
52  	 * get a property value of a given key. If the corresponding property is not found, return the default value
53  	 * 
54  	 * @param key
55  	 * @param defaultValue
56  	 * @return the property value of the key if it exists, otherwise return the defaultValue
57  	 */
58  	public String getProperty(String key, String defaultValue);
59  
60  	public TrackWindow getTrackWindow();
61  
62  	public void toXML(XMLWriter xmlWriter);
63  }