org.alfresco.repo.web.scripts.dictionary
Class DictionaryWebServiceBase

java.lang.Object
  extended by org.springframework.extensions.webscripts.AbstractWebScript
      extended by org.springframework.extensions.webscripts.DeclarativeWebScript
          extended by org.alfresco.repo.web.scripts.dictionary.DictionaryWebServiceBase
All Implemented Interfaces:
org.springframework.extensions.webscripts.WebScript
Direct Known Subclasses:
AssociationGet, AssociationsGet, ClassesGet, ClassGet, DictionaryGet, PropertiesGet, PropertyGet, SubClassesGet

public abstract class DictionaryWebServiceBase
extends org.springframework.extensions.webscripts.DeclarativeWebScript

Base class for Dictionary web scripts


Nested Class Summary
 
Nested classes/interfaces inherited from class org.springframework.extensions.webscripts.AbstractWebScript
org.springframework.extensions.webscripts.AbstractWebScript.ScriptDetails
 
Field Summary
protected  org.alfresco.service.cmr.dictionary.DictionaryService dictionaryservice
          Dictionary service
protected  org.alfresco.service.namespace.NamespaceService namespaceService
          Namespace service
 
Constructor Summary
DictionaryWebServiceBase()
           
 
Method Summary
protected  org.alfresco.service.namespace.QName createClassQName(java.lang.String className)
           
 java.lang.String getFullNamespaceURI(java.lang.String classname)
           
 java.lang.String getNamespaceURIfromQname(org.alfresco.service.namespace.QName qname)
           
 java.lang.String getPrefix(java.lang.String classname)
           
 java.util.Map getPrefixesAndUrlsMap()
           
 java.lang.String getPrefixFromModelName(java.lang.String modelname)
           
 java.lang.String getShortName(java.lang.String classname)
           
 java.util.Map getUrlsAndPrefixesMap()
           
 java.lang.String getValidInput(java.lang.String input)
           
 void init()
          Init method.
 boolean isValidAssociationFilter(java.lang.String af)
           
 boolean isValidClassFilter(java.lang.String classfilter)
           
 boolean isValidClassname(java.lang.String classname)
           
 boolean isValidModelName(java.lang.String modelname)
           
 boolean isValidTypeorAspect(java.lang.String classname)
           
 void setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
          Set the dictionaryService property.
 void setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceservice)
          Set the namespaceService property.
 
Methods inherited from class org.springframework.extensions.webscripts.DeclarativeWebScript
execute, executeFinallyImpl, executeImpl, executeImpl, executeImpl, getTemplateModel, renderFormatTemplate
 
Methods inherited from class org.springframework.extensions.webscripts.AbstractWebScript
createArgs, createArgsM, createHeaders, createHeadersM, createScriptParameters, createStatusException, createTemplateParameters, executeScript, getContainer, getDescription, getExecuteScript, getResources, getStatusTemplate, init, renderString, renderString, renderTemplate, sendStatus, setURLModelFactory, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

namespaceService

protected org.alfresco.service.namespace.NamespaceService namespaceService
Namespace service


dictionaryservice

protected org.alfresco.service.cmr.dictionary.DictionaryService dictionaryservice
Dictionary service

Constructor Detail

DictionaryWebServiceBase

public DictionaryWebServiceBase()
Method Detail

setNamespaceService

public void setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceservice)
Set the namespaceService property.

Parameters:
namespaceService - The namespace service instance to set

setDictionaryService

public void setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
Set the dictionaryService property.

Parameters:
dictionaryService - The dictionary service instance to set

init

public void init()
Init method.


createClassQName

protected org.alfresco.service.namespace.QName createClassQName(java.lang.String className)

getNamespaceURIfromQname

public java.lang.String getNamespaceURIfromQname(org.alfresco.service.namespace.QName qname)
Parameters:
qname -
Returns:
the namespaceuri from a qname

getFullNamespaceURI

public java.lang.String getFullNamespaceURI(java.lang.String classname)
Parameters:
className - the class name as cm_person
Returns:
String the full name in the following format {namespaceuri}shorname

isValidClassname

public boolean isValidClassname(java.lang.String classname)
Parameters:
classname - - checks whether the classname is valid , gets the classname as input e.g cm_person
Returns:
true - if the class is valid , false - if the class is invalid

getPrefixFromModelName

public java.lang.String getPrefixFromModelName(java.lang.String modelname)
Parameters:
namespaceprefix - - gets a valid namespaceprefix as input
Returns:
modelname from namespaceprefix - returns null if invalid namespaceprefix is given

isValidAssociationFilter

public boolean isValidAssociationFilter(java.lang.String af)

isValidTypeorAspect

public boolean isValidTypeorAspect(java.lang.String classname)
Parameters:
classname - as the input
Returns:
true if it is a aspect or false if it is a Type

isValidModelName

public boolean isValidModelName(java.lang.String modelname)
Parameters:
modelname - - gets the modelname as the input (modelname is without prefix ie. cm:contentmodel => where modelname = contentmodel)
Returns:
true if valid or false

getPrefix

public java.lang.String getPrefix(java.lang.String classname)
Parameters:
classname - - returns the prefix from the classname of the format namespaceprefix:name eg. cm_person
Returns:
prefix - returns the prefix of the classname

getShortName

public java.lang.String getShortName(java.lang.String classname)
Parameters:
classname -

getValidInput

public java.lang.String getValidInput(java.lang.String input)
Parameters:
input - -gets a string input and validates it
Returns:
null if invalid or the string itself if its valid

isValidClassFilter

public boolean isValidClassFilter(java.lang.String classfilter)
Parameters:
classfilter - =>valid class filters are all,apect or type
Returns:
true if valid or false if invalid

getPrefixesAndUrlsMap

public java.util.Map getPrefixesAndUrlsMap()
Returns:
a string map or prefixes and urls - with prefix as the key

getUrlsAndPrefixesMap

public java.util.Map getUrlsAndPrefixesMap()
Returns:
a string map of urls and prefixes - with url as the key


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.