001: /*
002: * Licensed to the Apache Software Foundation (ASF) under one or more
003: * contributor license agreements. See the NOTICE file distributed with
004: * this work for additional information regarding copyright ownership.
005: * The ASF licenses this file to You under the Apache License, Version 2.0
006: * (the "License"); you may not use this file except in compliance with
007: * the License. You may obtain a copy of the License at
008: *
009: * http://www.apache.org/licenses/LICENSE-2.0
010: *
011: * Unless required by applicable law or agreed to in writing, software
012: * distributed under the License is distributed on an "AS IS" BASIS,
013: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014: * See the License for the specific language governing permissions and
015: * limitations under the License.
016: */
017: package org.apache.jetspeed.portalsite.menu;
018:
019: import org.apache.jetspeed.om.folder.impl.StandardMenuOptionsDefinitionImpl;
020:
021: /**
022: * This class provides a menu options definition for options
023: * constructed directly from menu definitions.
024: *
025: * @author <a href="mailto:rwatler@apache.org">Randy Watler</a>
026: * @version $Id: DefaultMenuOptionsDefinition.java 516448 2007-03-09 16:25:47Z ate $
027: */
028: public class DefaultMenuOptionsDefinition extends
029: StandardMenuOptionsDefinitionImpl {
030: /**
031: * options - options path specification for menu
032: */
033: private String options;
034:
035: /**
036: * depth - inclusion depth for menu options
037: */
038: private int depth;
039:
040: /**
041: * paths - generate ordered paths flag for menu options
042: */
043: private boolean paths;
044:
045: /**
046: * regexp - regexp flag for menu options
047: */
048: private boolean regexp;
049:
050: /**
051: * profile - profile locator for menu options
052: */
053: private String profile;
054:
055: /**
056: * order - comma separated regexp ordering patterns for menu options
057: */
058: private String order;
059:
060: /**
061: * DefaultMenuOptionsDefinition - constructor
062: */
063: public DefaultMenuOptionsDefinition(String options, int depth,
064: boolean paths, boolean regexp, String locatorName,
065: String order) {
066: super ();
067: this .options = options;
068: this .depth = depth;
069: this .paths = paths;
070: this .regexp = regexp;
071: this .profile = locatorName;
072: this .order = order;
073: }
074:
075: /**
076: * getOptions - get comma separated menu options if not specified as elements
077: *
078: * @return option paths specification
079: */
080: public String getOptions() {
081: return options;
082: }
083:
084: /**
085: * getDepth - get depth of inclusion for folder menu options
086: *
087: * @return inclusion depth
088: */
089: public int getDepth() {
090: return depth;
091: }
092:
093: /**
094: * isPaths - get generate ordered path options
095: *
096: * @return paths options flag
097: */
098: public boolean isPaths() {
099: return paths;
100: }
101:
102: /**
103: * isRegexp - get regexp flag for interpreting options
104: *
105: * @return regexp flag
106: */
107: public boolean isRegexp() {
108: return regexp;
109: }
110:
111: /**
112: * getProfile - get profile locator used to filter specified options
113: *
114: * @return profile locator name
115: */
116: public String getProfile() {
117: return profile;
118: }
119:
120: /**
121: * getOrder - get comma separated regexp ordering patterns
122: *
123: * @return ordering patterns list
124: */
125: public String getOrder() {
126: return order;
127: }
128: }
|