org.apache.solr.rest.schema

Class DynamicFieldCollectionResource

java.lang.Object

org.restlet.resource.Resource

org.restlet.resource.UniformResource

org.restlet.resource.ServerResource

org.apache.solr.rest.BaseSolrResource

org.apache.solr.rest.schema.DynamicFieldCollectionResource

All Implemented Interfaces:

GETable

public class DynamicFieldCollectionResource
extends BaseSolrResource
implements GETable

This class responds to requests at /solr/(corename)/schema/dynamicfields

To restrict the set of dynamic fields in the response, specify a comma and/or space separated list of dynamic field patterns in the "fl" query parameter.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.solr.rest.BaseSolrResource

BaseSolrResource.SolrOutputRepresentation

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	INCLUDE_DYNAMIC_PARAM

Fields inherited from class org.apache.solr.rest.BaseSolrResource

SHOW_DEFAULTS, UTF8

Constructor Summary

Constructors

Constructor and Description
DynamicFieldCollectionResource()

Method Summary

Methods

Modifier and Type	Method and Description
void	doInit() Pulls the "fl" param from the request and splits it to get the requested list of fields.
org.restlet.representation.Representation	get()
protected SimpleOrderedMap<Object>	getFieldProperties(SchemaField field) Get the properties for a given field.
protected LinkedHashSet<String>	getRequestedFields()

Methods inherited from class org.apache.solr.rest.BaseSolrResource

getContentType, getSchema, getSolrCore, getSolrRequest, getSolrResponse, handleException, handlePostExecution, isImmutableConfigSet, urlDecode

Methods inherited from class org.restlet.resource.ServerResource

abort, commit, delete, delete, describeVariants, doCatch, doConditionalHandle, doError, doHandle, doHandle, doNegotiatedHandle, get, getAttribute, getInfo, getInfo, getOnSent, getPreferredVariant, getVariants, getVariants, handle, hasAnnotations, head, head, isAnnotated, isAutoCommitting, isCommitted, isConditional, isExisting, isInRole, isNegotiated, options, 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

INCLUDE_DYNAMIC_PARAM

protected static final String INCLUDE_DYNAMIC_PARAM

See Also:

Constant Field Values

Constructor Detail

DynamicFieldCollectionResource

public DynamicFieldCollectionResource()

Method Detail

doInit

public void doInit()
            throws org.restlet.resource.ResourceException

Pulls the "fl" param from the request and splits it to get the requested list of fields. The (Dynamic)FieldCollectionResource classes will then restrict the fields sent back in the response to those on this list. The (Dynamic)FieldResource classes ignore this list, since the (dynamic) field is specified in the URL path, rather than in a query parameter.

Also pulls the "showDefaults" param from the request, for use by all subclasses to include default values from the associated field type in the response. By default this param is off.

Throws:

org.restlet.resource.ResourceException

get

public org.restlet.representation.Representation get()

Specified by:

get in interface GETable

Overrides:

get in class org.restlet.resource.ServerResource

getRequestedFields

protected LinkedHashSet<String> getRequestedFields()

getFieldProperties

protected SimpleOrderedMap<Object> getFieldProperties(SchemaField field)

Get the properties for a given field.

Parameters:

field - not required to exist in the schema