edu.northwestern.at.morphadorner.server

Class BaseAdornerServerResource

java.lang.Object

org.restlet.resource.Resource

org.restlet.resource.UniformResource

org.restlet.resource.ServerResource

org.restlet.ext.wadl.WadlServerResource

edu.northwestern.at.morphadorner.server.BaseAdornerServerResource

Direct Known Subclasses:

CorpusConfigResource, GapFillerResource, HyphenatorResource, LanguageRecognizerResource, LemmatizerResource, LexiconLookupResource, NameRecognizerResource, ParserResource, PartOfSpeechTaggerResource, PluralizerResource, SentenceSplitterResource, SpellingStandardizerResource, SummarizerResource, SyllableCounterResource, TEIAdornedToSentencesResource, TEIAdornedToTabularFileResource, TEIAdornerResource, TEIApplyChangesToAdornedFileResource, TEICompareAdornedFilesResource, TEINotesMoverResource, TEIToTextResource, TEIUnadornerResource, TextSegmenterResource, ThesaurusResource, VerbConjugatorResource, VersionResource, WordTokenizerResource

public class BaseAdornerServerResource
extends org.restlet.ext.wadl.WadlServerResource

Base server resource class providing common methods shared by MorphAdorner server resources.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BaseAdornerServerResource.ParameterInfoComparable Comparator class for ParameterInfo object.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	HEADERS_KEY Headers key.
static java.lang.String	WADLBOOLEAN
static java.lang.String	WADLINT
static java.lang.String	WADLSTRING WADL parameter types.

Constructor Summary

Constructors

Constructor and Description
BaseAdornerServerResource() Create BaseAdornerServerResource.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCORSHeaders() Add CORS headers to response.
void	addStatusCodes(org.restlet.ext.wadl.MethodInfo methodInfo) Add common status codes.
protected org.restlet.representation.Representation	createHtmlRepresentation(org.restlet.ext.wadl.ApplicationInfo applicationInfo) Creates a new HTML representation for a given WadlServerResource instance describing a server resource.
protected void	describeGet(org.restlet.ext.wadl.MethodInfo methodInfo) Describe Get status codes.
protected java.util.List<org.restlet.ext.wadl.ParameterInfo>	describeParameters() Describe the parameters.
protected void	describePost(org.restlet.ext.wadl.MethodInfo methodInfo) Describe Post status codes.
void	doOptions(org.restlet.representation.Representation entity) Handle options to implement CORS.
java.util.List<java.util.List<java.lang.String>>	extractSentences(java.lang.String text, java.lang.String langCode, java.lang.String corpusConfig) Extract sentences from a text field.
static boolean	getBooleanValue(java.lang.String requestValue, boolean defaultValue) Gets boolean parameter value.
static int	getIntValue(java.lang.String requestValue, int defaultValue) Gets integer parameter value.
protected org.restlet.util.Series<org.restlet.engine.header.Header>	getMessageHeaders(org.restlet.Message message) Retrieve headers from a message.
java.lang.String	hyphenate(java.lang.String spelling, boolean american) Hyphenate a spelling.
<T extends BaseResults> org.restlet.representation.Representation	postResults(org.restlet.data.Form queryParams, T results) Return output representation for POST operation.
<T extends BaseResults> org.restlet.representation.Representation	postResults(org.restlet.data.Form queryParams, T results, java.lang.String aliasName, java.lang.Class aliasClass) Return output representation for POST operation.
<T extends BaseResults> org.restlet.representation.Representation	postResults(org.restlet.data.Form queryParams, T results, java.lang.String aliasName, java.lang.Class aliasClass, java.lang.String aliasName2, java.lang.Class aliasClass2) Return output representation for POST operation.
<T extends BaseResults> org.restlet.representation.Representation	postResults(org.restlet.data.Form queryParams, T results, java.lang.String aliasName, java.lang.Class aliasClass, java.lang.String aliasName2, java.lang.Class aliasClass2, java.lang.String aliasName3, java.lang.Class aliasClass3) Return output representation for POST operation.
java.lang.String	recognizeLanguage(java.lang.String text) Find language code for language of text.
java.lang.String	recognizeLanguage(java.lang.String text, java.lang.String defaultLangCode) Find language code for language of text.
java.util.List<org.restlet.ext.wadl.ParameterInfo>	sortParams(java.util.List<org.restlet.ext.wadl.ParameterInfo> params) Sort parameter info list.
java.lang.String	unTag(java.lang.String text) Remove HTML/XML tags from text.

Methods inherited from class org.restlet.ext.wadl.WadlServerResource

canDescribe, createWadlRepresentation, describe, describe, describe, describe, describe, describe, describe, describe, describeDelete, describeMethod, describeMethod, describeOptions, describePut, doInit, getDescription, getName, getParameter, getParameters, getPreferredWadlVariant, getResourcePath, getResourcesBase, getWadlVariants, isAutoDescribing, options, setAutoDescribing, setDescription, setName

Methods inherited from class org.restlet.resource.ServerResource

abort, commit, delete, delete, describeVariants, doCatch, doConditionalHandle, doError, doHandle, doHandle, doNegotiatedHandle, get, get, getAttribute, getInfo, getInfo, getOnSent, getPreferredVariant, getVariants, getVariants, handle, hasAnnotations, head, head, isAnnotated, isAutoCommitting, isCommitted, isConditional, isExisting, isInRole, isNegotiated, options, post, post, put, put, redirectPermanent, redirectPermanent, redirectSeeOther, redirectSeeOther, redirectTemporary, redirectTemporary, setAllowedMethods, setAnnotated, setAttribute, setAutoCommitting, setChallengeRequests, setCommitted, setConditional, setCookieSettings, setDimensions, setExisting, setLocationRef, setLocationRef, setNegotiated, setOnSent, setProxyChallengeRequests, setServerInfo, setStatus, setStatus, setStatus, setStatus, updateAllowedMethods, updateDimensions

Methods inherited from class org.restlet.resource.Resource

doError, doRelease, getAllowedMethods, getApplication, getChallengeRequests, getChallengeResponse, getClientInfo, getConditions, getConnegService, getContext, getConverterService, getCookies, getCookieSettings, getDimensions, getHostRef, getLocationRef, getLogger, getMatrix, getMatrixValue, getMaxForwards, getMetadataService, getMethod, getOriginalRef, getProtocol, getProxyChallengeRequests, getProxyChallengeResponse, getQuery, getQueryValue, getRanges, getReference, getReferrerRef, getRequest, getRequestAttributes, getRequestCacheDirectives, getRequestEntity, getResponse, getResponseAttributes, getResponseCacheDirectives, getResponseEntity, getRootRef, getServerInfo, getStatus, getStatusService, init, isConfidential, isLoggable, release, setApplication, setQueryValue, setRequest, setResponse, toObject, toRepresentation, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

WADLSTRING

public static java.lang.String WADLSTRING

WADL parameter types.

WADLINT

public static java.lang.String WADLINT

WADLBOOLEAN

public static java.lang.String WADLBOOLEAN

HEADERS_KEY

protected static final java.lang.String HEADERS_KEY

Headers key.

See Also:

Constant Field Values

Constructor Detail

BaseAdornerServerResource

public BaseAdornerServerResource()

Create BaseAdornerServerResource.

Method Detail

getMessageHeaders

protected org.restlet.util.Series<org.restlet.engine.header.Header> getMessageHeaders(org.restlet.Message message)

Retrieve headers from a message.

Parameters:

message - The message.

Returns:

Series

containing headers.

doOptions

@Options
public void doOptions(org.restlet.representation.Representation entity)

Handle options to implement CORS.

Parameters:

entity - Input options entity.

addCORSHeaders

public void addCORSHeaders()

Add CORS headers to response.

describeParameters

protected java.util.List<org.restlet.ext.wadl.ParameterInfo> describeParameters()

Describe the parameters.

Overrides:

describeParameters in class org.restlet.ext.wadl.WadlServerResource

Returns:

Parameters as list of ParameterInfo objects.

Adds a description only for the "media" parameter, which is common to all the resources.

unTag

public java.lang.String unTag(java.lang.String text)

Remove HTML/XML tags from text.

Parameters:

text - The text from which to remove tags.

Returns:

The text with tags removed.

getIntValue

public static int getIntValue(java.lang.String requestValue,
              int defaultValue)

Gets integer parameter value.

Parameters:

requestValue - Parameter value from request.

defaultValue - Default parameter value if parameter null or invalid.

Returns:

The parameter value, or the defaultValue if paramValue is null or invalid.

getBooleanValue

public static boolean getBooleanValue(java.lang.String requestValue,
                      boolean defaultValue)

Gets boolean parameter value.

Parameters:

requestValue - Parameter value from request.

defaultValue - Default parameter value if parameter null or invalid.

Returns:

The parameter value, or the defaultValue if paramValue is null or invalid.

recognizeLanguage

public java.lang.String recognizeLanguage(java.lang.String text,
                                 java.lang.String defaultLangCode)

Find language code for language of text.

Parameters:

text - Text for which to determine language code.

defaultLangCode - Default ISO language code if language cannot be determined.

Returns:

ISO language code. Specified default if language cannot be found.

recognizeLanguage

public java.lang.String recognizeLanguage(java.lang.String text)

Find language code for language of text.

Parameters:

text - Text for which to determine language code.

Returns:

ISO language code. Set to English if language cannot be found.

hyphenate

public java.lang.String hyphenate(java.lang.String spelling,
                         boolean american)

Hyphenate a spelling.

Parameters:

spelling - Spelling to hyphenate.

american - True to use American rules rather than British.

Returns:

Hyphenated spelling.

extractSentences

public java.util.List<java.util.List<java.lang.String>> extractSentences(java.lang.String text,
                                                                java.lang.String langCode,
                                                                java.lang.String corpusConfig)

Extract sentences from a text field.

Parameters:

text - Text from which to extract sentences.

langCode - Language code for language of text.

corpusConfig - Corpus configuration for language.

Returns:

List of sentences.

postResults

public <T extends BaseResults> org.restlet.representation.Representation postResults(org.restlet.data.Form queryParams,
                                                                            T results,
                                                                            java.lang.String aliasName,
                                                                            java.lang.Class aliasClass,
                                                                            java.lang.String aliasName2,
                                                                            java.lang.Class aliasClass2,
                                                                            java.lang.String aliasName3,
                                                                            java.lang.Class aliasClass3)

Return output representation for POST operation.

Parameters:

queryParams - The query parameters.

results - The results to be returned.

aliasName - Alias name.

aliasClass - Alias class.

aliasName2 - Alias name.

aliasClass2 - Alias class.

aliasName3 - Alias name.

aliasClass3 - Alias class.

postResults

public <T extends BaseResults> org.restlet.representation.Representation postResults(org.restlet.data.Form queryParams,
                                                                            T results,
                                                                            java.lang.String aliasName,
                                                                            java.lang.Class aliasClass,
                                                                            java.lang.String aliasName2,
                                                                            java.lang.Class aliasClass2)

Return output representation for POST operation.

Parameters:

queryParams - The query parameters.

results - The results to be returned.

aliasName - Alias name.

aliasClass - Alias class.

aliasName2 - Alias name.

aliasClass2 - Alias class.

postResults

public <T extends BaseResults> org.restlet.representation.Representation postResults(org.restlet.data.Form queryParams,
                                                                            T results,
                                                                            java.lang.String aliasName,
                                                                            java.lang.Class aliasClass)

Return output representation for POST operation.

Parameters:

queryParams - The query parameters.

results - The results to be returned.

aliasName - Alias name.

aliasClass - Alias class.

postResults

public <T extends BaseResults> org.restlet.representation.Representation postResults(org.restlet.data.Form queryParams,
                                                                            T results)

Return output representation for POST operation.

Parameters:

queryParams - The query parameters.

results - The results to be returned.

createHtmlRepresentation

protected org.restlet.representation.Representation createHtmlRepresentation(org.restlet.ext.wadl.ApplicationInfo applicationInfo)

Creates a new HTML representation for a given WadlServerResource instance describing a server resource.

Overrides:

createHtmlRepresentation in class org.restlet.ext.wadl.WadlServerResource

Parameters:

applicationInfo - The application description.

Returns:

The created WadlRepresentation.

The built-in restlet WADL to HTML transformation is broken, so we replace it commpletely.

sortParams

public java.util.List<org.restlet.ext.wadl.ParameterInfo> sortParams(java.util.List<org.restlet.ext.wadl.ParameterInfo> params)

Sort parameter info list.

Parameters:

params - List of ParameterInfo objects.

Returns:

params list sorted by name.

addStatusCodes

public void addStatusCodes(org.restlet.ext.wadl.MethodInfo methodInfo)

Add common status codes.

Parameters:

methodInfo - Method information in which to store status code.

describeGet

protected void describeGet(org.restlet.ext.wadl.MethodInfo methodInfo)

Describe Get status codes.

Overrides:

describeGet in class org.restlet.ext.wadl.WadlServerResource

Parameters:

methodInfo - Get method information in which to store status codes.

describePost

protected void describePost(org.restlet.ext.wadl.MethodInfo methodInfo)

Describe Post status codes.

Overrides:

describePost in class org.restlet.ext.wadl.WadlServerResource

Parameters:

methodInfo - Get method information in which to store status codes.