|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface UrlMapping
An interface that defines a URL mapping. A URL mapping is a mapping between a URI such as /book/list and a controller, action and/or id
A UrlMapping should implement Comparable so that UrlMapping instances can be ordered to allow for precendence rules. In other words the URL /book/list should be matched before /book/* as the wildcard is of lesser precedence. By implementing Comparable this can be allowed for.
| Field Summary | |
|---|---|
static String |
ACTION
|
static String |
CONTROLLER
|
| Method Summary | |
|---|---|
Object |
getActionName()
Retrieves the action name which is either a groovy.lang.Closure that evaluates the action name at runtime or a java.lang.String that represents the action name |
ConstrainedProperty[] |
getConstraints()
The constraints the apply to this UrlMapping. |
Object |
getControllerName()
Retrieves the controller name which is either a groovy.lang.Closure that evaluates the controller name at runtime or a java.lang.String that represents the controller name |
String |
getMappingName()
|
UrlMappingData |
getUrlData()
Retrieves the UrlMappingData instance that describes this UrlMapping |
Object |
getViewName()
Returns the name of the view to map to |
boolean |
hasRuntimeVariable(String name)
Whether the mapping has a runtime variable with the given name such as "/$foo" |
boolean |
isRestfulMapping()
|
UrlMappingInfo |
match(String uri)
Matches the given URI and returns an instance of the UrlMappingInfo interface or null if a match couldn't be established |
void |
setMappingName(String name)
|
void |
setParameterValues(Map parameterValues)
Sets any parameter values that should be populated into the request |
void |
setParseRequest(boolean shouldParse)
Sets whether this UrlMapping should parse the request |
void |
setRestfulMapping(boolean isREST)
|
| Methods inherited from interface java.lang.Comparable |
|---|
compareTo |
| Methods inherited from interface org.codehaus.groovy.grails.web.mapping.UrlCreator |
|---|
createRelativeURL, createRelativeURL, createURL, createURL, createURL, createURL |
| Field Detail |
|---|
static final String CONTROLLER
static final String ACTION
| Method Detail |
|---|
UrlMappingInfo match(String uri)
uri - The URI to match
UrlMappingData getUrlData()
ConstrainedProperty[] getConstraints()
The constraints the apply to this UrlMapping. Each constraint maps to a GString token in a URL mapping in order. For example consider the URL:
/blog/$author/$title/$year?/$month?/$day?
This results in 5 ConstrainedProperty instances called author, title, year, month and day
Object getControllerName()
Closure or StringObject getActionName()
Closure or StringObject getViewName()
void setParameterValues(Map parameterValues)
parameterValues - The parameter values to setvoid setParseRequest(boolean shouldParse)
shouldParse - True if it shouldString getMappingName()
void setMappingName(String name)
void setRestfulMapping(boolean isREST)
isREST - Set whether this is a RESTful mappingboolean isRestfulMapping()
boolean hasRuntimeVariable(String name)
name - The name of the variable
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||