View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    * 
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   * 
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.jetspeed.portalsite.menu;
18  
19  import org.apache.jetspeed.om.folder.impl.StandardMenuOptionsDefinitionImpl;
20  
21  /***
22   * This class provides a menu options definition for options
23   * constructed directly from menu definitions.
24   * 
25   * @author <a href="mailto:rwatler@apache.org">Randy Watler</a>
26   * @version $Id: DefaultMenuOptionsDefinition.java 516448 2007-03-09 16:25:47Z ate $
27   */
28  public class DefaultMenuOptionsDefinition extends StandardMenuOptionsDefinitionImpl
29  {
30      /***
31       * options - options path specification for menu
32       */
33      private String options;
34  
35      /***
36       * depth - inclusion depth for menu options
37       */
38      private int depth;
39  
40      /***
41       * paths - generate ordered paths flag for menu options
42       */
43      private boolean paths;
44  
45      /***
46       * regexp - regexp flag for menu options
47       */
48      private boolean regexp;
49  
50      /***
51       * profile - profile locator for menu options
52       */
53      private String profile;
54  
55      /***
56       * order - comma separated regexp ordering patterns for menu options
57       */
58      private String order;
59  
60      /***
61       * DefaultMenuOptionsDefinition - constructor
62       */
63      public DefaultMenuOptionsDefinition(String options, int depth, boolean paths, boolean regexp, String locatorName, String order)
64      {
65          super();
66          this.options = options;
67          this.depth = depth;
68          this.paths = paths;
69          this.regexp = regexp;
70          this.profile = locatorName;
71          this.order = order;
72      }
73  
74      /***
75       * getOptions - get comma separated menu options if not specified as elements
76       *
77       * @return option paths specification
78       */
79      public String getOptions()
80      {
81          return options;
82      }
83  
84      /***
85       * getDepth - get depth of inclusion for folder menu options
86       *
87       * @return inclusion depth
88       */
89      public int getDepth()
90      {
91          return depth;
92      }
93  
94      /***
95       * isPaths - get generate ordered path options
96       *
97       * @return paths options flag
98       */
99      public boolean isPaths()
100     {
101         return paths;
102     }
103     
104     /***
105      * isRegexp - get regexp flag for interpreting options
106      *
107      * @return regexp flag
108      */
109     public boolean isRegexp()
110     {
111         return regexp;
112     }
113 
114     /***
115      * getProfile - get profile locator used to filter specified options
116      *
117      * @return profile locator name
118      */
119     public String getProfile()
120     {
121         return profile;
122     }
123 
124     /***
125      * getOrder - get comma separated regexp ordering patterns
126      *
127      * @return ordering patterns list
128      */
129     public String getOrder()
130     {
131         return order;
132     }
133 }