001    // Copyright 2005 The Apache Software Foundation
002    //
003    // Licensed under the Apache License, Version 2.0 (the "License");
004    // you may not use this file except in compliance with the License.
005    // You may obtain a copy of the License at
006    //
007    //     http://www.apache.org/licenses/LICENSE-2.0
008    //
009    // Unless required by applicable law or agreed to in writing, software
010    // distributed under the License is distributed on an "AS IS" BASIS,
011    // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012    // See the License for the specific language governing permissions and
013    // limitations under the License.
014    
015    package org.apache.tapestry.record;
016    
017    import org.apache.hivemind.util.Defense;
018    
019    /**
020     * Base implementation of {@link org.apache.tapestry.record.ClientPropertyPersistenceScope} wherein
021     * the scopes are recognized via a prefix on the page name to form the query parameter name.
022     * Capiche?
023     * 
024     * @author Howard Lewis Ship
025     * @since 4.0
026     */
027    public abstract class AbstractPrefixedClientPropertyPersistenceScope implements
028            ClientPropertyPersistenceScope
029    {
030        private final String _prefix;
031    
032        public AbstractPrefixedClientPropertyPersistenceScope(String prefix)
033        {
034            Defense.notNull(prefix, "prefix");
035    
036            _prefix = prefix;
037        }
038    
039        public String constructParameterName(String pageName)
040        {
041            return _prefix + pageName;
042        }
043    
044        public boolean isParameterForScope(String parameterName)
045        {
046            return parameterName.startsWith(_prefix);
047        }
048    
049        public String extractPageName(String parameterName)
050        {
051            return parameterName.substring(_prefix.length());
052        }
053    
054    }