2009/05/20 - Apache Shale has been retired.

For more information, please explore the Attic.

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  
18  package org.apache.shale.dialog.scxml.impl;
19  
20  import javax.faces.context.FacesContext;
21  
22  import org.apache.shale.dialog.scxml.DialogStateMapper;
23  
24  /***
25   * <p>Default {@link DialogStateMapper} implementation. The dialog state
26   * identifier itself is used as the JavaServer Faces
27   * <code>view identifier</code>.</p>
28   *
29   * @since 1.0.4
30   *
31   * $Id: DefaultDialogStateMapper.java 469656 2006-10-31 21:18:18Z rahul $
32   */
33  public class DefaultDialogStateMapper implements DialogStateMapper {
34  
35      /***
36       * <p>The default implementation is an identity transform which
37       * returns the dialog state ID as the next JavaServer Faces
38       * <code>view identifier</code>.</p>
39       *
40       * @param dialogName The logical name of the dialog this state belongs to
41       * @param stateId The state identifier for the current dialog state
42       * @param context The current {@link FacesContext}
43       * @return The JavaServer Faces <code>view identifier</code> that should
44       *         be rendered
45       */
46      public String mapStateId(String dialogName, String stateId,
47              FacesContext context) {
48  
49          // the identity transform
50          return stateId;
51  
52      }
53  
54  }
55