com.adobe.cq.social.srp.internal

Class AbstractSchemaMapper

java.lang.Object

com.adobe.cq.social.srp.internal.AbstractSchemaMapper

public abstract class AbstractSchemaMapper
extends java.lang.Object

This class maps from SoCo keys and values to those used by the common schema developed by Adobe Social. This class is only intended to be used by Communities code.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AS_CQ_DATA

Constructor Summary

Constructors

Constructor and Description
AbstractSchemaMapper() ctor.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	escapeForSolr(java.lang.String base) Escape things that need to go to solr.
abstract void	finalizeSchemaMapping(java.util.Map<java.lang.String,java.lang.Object> socoData, java.util.Map<java.lang.String,java.lang.Object> schemaMap) Subclasses can implement this to muck with the mapping before it is actually committed.
java.util.Map<java.lang.String,java.lang.Object>	fromAttachmentSchema(java.util.Map<java.lang.String,java.lang.Object> input) Convert attachment data from the schema to what SoCo expects.
java.util.Map<java.lang.String,java.lang.Object>	fromSchema(java.util.Map<java.lang.String,java.lang.Object> schemaData) Convert the data from schema into the format expected by SoCo.
static java.util.Calendar	fromSchemaDate(java.lang.String key, java.lang.Object asDate) Return a Calendar object from a date value in the schema format.
java.lang.String	fromSchemaKey(java.lang.String schemaKey) Get the CQ mapping of a schema field.
static java.lang.String	getBaseType()
abstract java.util.Map<java.lang.String,java.lang.String>	getMapperSpecificKeys() fetch the keys that are specific to this impl that need to be mapped.
static java.lang.String	getMutliLingualLanguageKey(java.lang.String strLanguage) Returns the translation language specified as the last name in the key path
abstract java.lang.String	getReportSuite()
static java.lang.String	getSchemaApprovedKey()
static java.lang.String	getSchemaAttachmentKey()
static java.lang.String	getSchemaAttachmentLengthKey()
static java.lang.String	getSchemaAttachmentUploadDateKey()
static java.lang.String	getSchemaBaseType()
static java.lang.String	getSchemaCQData()
static java.lang.String	getSchemaDescriptionKey()
static java.lang.String	getSchemaFlaggedHiddenKey()
static java.lang.String	getSchemaIsDraftKey()
static java.lang.String	getSchemaParentIdKey()
static java.lang.String	getSchemaProviderIdKey()
static java.lang.String	getSchemaResourceTypeKey()
static java.lang.String	getSchemaRootCommentSystemKey()
static java.lang.String	getSchemaTimestampKey()
static java.lang.String	getSocoAddedKey()
static java.lang.String	getSocoApprovedKey()
static java.lang.String	getSocoAuthorDisplayNameKey()
static java.lang.String	getSocoAuthorImageUrlKey()
static java.lang.String	getSocoAuthorProfileUrlKey()
static java.lang.String	getSocoDescriptionKey()
static java.lang.String	getSocoDraftKey()
static java.lang.String	getSocoEntityUrlKey()
static java.lang.String	getSocoFlaggedHiddenKey()
static java.lang.String	getSocoKey()
static java.lang.String	getSocoLastModifiedKey()
static java.lang.String	getSocoParentIdKey()
static java.lang.String	getSocoTallyTimestampKey()
static java.lang.String	getTranslationFolderName()
static java.lang.String	getUserDatePrefix()
java.lang.String	luceneToSolr(java.lang.String luceneQuery) Convert a lucene query to Solr query Maps the CQ names to Solr names.
abstract void	setReportSuite(java.lang.String reportSuite) set the report suite used in this mapper.
java.util.Map<java.lang.String,java.lang.Object>	toAttachmentSchema(java.util.Map<java.lang.String,java.lang.Object> data, java.lang.String key) Format a Map using the keys expected by the schema.
java.util.Map<java.lang.String,java.lang.Object>	toSchema(java.util.Map<java.lang.String,java.lang.Object> cqFormat, java.lang.String key) Map from the cq data format to the format expected by the schema.
java.lang.String	toSchemaKey(java.lang.String cqKey) Get the schema mapping of a SoCo field.
java.util.List<java.lang.String>	toSchemaKeys(java.lang.String mltField) Get the schema field name(s) associated with a given SoCo field.
abstract java.util.Map<java.lang.String,java.lang.Object>	toSolrSchema(java.util.Map<java.lang.String,java.lang.Object> cqFormat, java.lang.String key) Convert to a format solr likes.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

AS_CQ_DATA

public static final java.lang.String AS_CQ_DATA

See Also:

Constant Field Values

Constructor Detail

AbstractSchemaMapper

public AbstractSchemaMapper()

ctor.

Method Detail

getMapperSpecificKeys

public abstract java.util.Map<java.lang.String,java.lang.String> getMapperSpecificKeys()

fetch the keys that are specific to this impl that need to be mapped.

Returns:

the keys (going from the schema key to the soco key) to be mapped

getReportSuite

public abstract java.lang.String getReportSuite()

Returns:

the report suite used in this mapper.

setReportSuite

public abstract void setReportSuite(java.lang.String reportSuite)

set the report suite used in this mapper.

Parameters:

reportSuite - the report suite

getSchemaDescriptionKey

public static java.lang.String getSchemaDescriptionKey()

Returns:

the key used in the db schema that tells the description

getSchemaResourceTypeKey

public static java.lang.String getSchemaResourceTypeKey()

Returns:

the key used in the schema to tell the resource type.

getSchemaRootCommentSystemKey

public static java.lang.String getSchemaRootCommentSystemKey()

Returns:

the key used in the schema to tell the location of the root comment system.

getSocoAuthorDisplayNameKey

public static java.lang.String getSocoAuthorDisplayNameKey()

Returns:

the key used in soco to tell the author's display name.

getSocoAuthorImageUrlKey

public static java.lang.String getSocoAuthorImageUrlKey()

Returns:

the key used in the soco to tell the author's avatar url.

getSocoAuthorProfileUrlKey

public static java.lang.String getSocoAuthorProfileUrlKey()

Returns:

the key used in the soco to tell the author's avatar url.

getSocoEntityUrlKey

public static java.lang.String getSocoEntityUrlKey()

Returns:

the key used in the soco to tell the entity url.

getSocoApprovedKey

public static java.lang.String getSocoApprovedKey()

Returns:

the key used in the soco to tell approval status.

getSocoFlaggedHiddenKey

public static java.lang.String getSocoFlaggedHiddenKey()

Returns:

the key used in the soco to tell approval status.

getSocoDraftKey

public static java.lang.String getSocoDraftKey()

getSchemaApprovedKey

public static java.lang.String getSchemaApprovedKey()

Returns:

the key used in the schema to tell the approval status.

getSchemaFlaggedHiddenKey

public static java.lang.String getSchemaFlaggedHiddenKey()

Returns:

the key used in the schema to tell the approval status.

getSchemaIsDraftKey

public static java.lang.String getSchemaIsDraftKey()

getSchemaParentIdKey

public static java.lang.String getSchemaParentIdKey()

Returns:

the key used in the schema to tell the parent id.

getSchemaProviderIdKey

public static java.lang.String getSchemaProviderIdKey()

Returns:

the key used in the schema to tell the provider id.

getSchemaTimestampKey

public static java.lang.String getSchemaTimestampKey()

Returns:

the key used in the schema to tell the creation time.

getSchemaAttachmentLengthKey

public static java.lang.String getSchemaAttachmentLengthKey()

Returns:

the key used in schema to tell the attachment length.

getSchemaAttachmentUploadDateKey

public static java.lang.String getSchemaAttachmentUploadDateKey()

Returns:

the key used in schema to tell the attachment creation time.

getSocoAddedKey

public static java.lang.String getSocoAddedKey()

Returns:

the key used in soco to tell the creation time.

getSocoParentIdKey

public static java.lang.String getSocoParentIdKey()

Returns:

the key used in soco to tell the parentid.

getSocoTallyTimestampKey

public static java.lang.String getSocoTallyTimestampKey()

Returns:

the key used in soco to tell the tally timestamp.

getSocoLastModifiedKey

public static java.lang.String getSocoLastModifiedKey()

Returns:

the key used in soco to tell modification date.

getSchemaAttachmentKey

public static java.lang.String getSchemaAttachmentKey()

Returns:

the key used in soco to tell if there are attachments.

getSocoKey

public static java.lang.String getSocoKey()

Returns:

the key for a piece of ugc.

getSocoDescriptionKey

public static java.lang.String getSocoDescriptionKey()

Returns:

the key used in soco to give the description associated with the ugc.

escapeForSolr

public static java.lang.String escapeForSolr(java.lang.String base)

Escape things that need to go to solr.

Parameters:

base - the original string

Returns:

the converted string.

getUserDatePrefix

public static java.lang.String getUserDatePrefix()

Returns:

The prefix used to identify non dynamic user date properties.

getSchemaBaseType

public static java.lang.String getSchemaBaseType()

Returns:

The social base type.

getBaseType

public static java.lang.String getBaseType()

Returns:

The CQ base type.

getSchemaCQData

public static java.lang.String getSchemaCQData()

getTranslationFolderName

public static java.lang.String getTranslationFolderName()

Returns:

The CQ translation folder name.

toSchema

public java.util.Map<java.lang.String,java.lang.Object> toSchema(java.util.Map<java.lang.String,java.lang.Object> cqFormat,
                                                                 java.lang.String key)

Map from the cq data format to the format expected by the schema.

Parameters:

cqFormat - the incoming data. Note that this routine can change the contents of the map so that it is appropriate for caching. If you don't like that, make a copy of the map before sending it in.

key - the key for the data

Returns:

the mapped data

getMutliLingualLanguageKey

public static java.lang.String getMutliLingualLanguageKey(java.lang.String strLanguage)

Returns the translation language specified as the last name in the key path

finalizeSchemaMapping

public abstract void finalizeSchemaMapping(java.util.Map<java.lang.String,java.lang.Object> socoData,
                                           java.util.Map<java.lang.String,java.lang.Object> schemaMap)

Subclasses can implement this to muck with the mapping before it is actually committed. This is useful for the little nitty differences between impls.

Parameters:

socoData - the data in the SoCo format

schemaMap - the data to be committed (in the common schema)

toAttachmentSchema

public java.util.Map<java.lang.String,java.lang.Object> toAttachmentSchema(java.util.Map<java.lang.String,java.lang.Object> data,
                                                                           java.lang.String key)
                                                                    throws java.io.IOException

Format a Map using the keys expected by the schema.

Parameters:

data - the data to be uploaded

key - the key for the attachment

Returns:

the data with the keys expected by the schema

Throws:

java.io.IOException - on failure

fromSchemaDate

public static java.util.Calendar fromSchemaDate(java.lang.String key,
                                                java.lang.Object asDate)

Return a Calendar object from a date value in the schema format. If value is an invalid date format (perhaps from a legacy format we no longer know about or bugs from previous coding), return the current time as a place holder.

Parameters:

key - the key to convert

asDate - the original date, in schema format

Returns:

the converted date

fromSchema

public java.util.Map<java.lang.String,java.lang.Object> fromSchema(java.util.Map<java.lang.String,java.lang.Object> schemaData)

Convert the data from schema into the format expected by SoCo.

Parameters:

schemaData - the data to be converted

Returns:

the mapped data

fromAttachmentSchema

public java.util.Map<java.lang.String,java.lang.Object> fromAttachmentSchema(java.util.Map<java.lang.String,java.lang.Object> input)

Convert attachment data from the schema to what SoCo expects.

Parameters:

input - the data in the schema

Returns:

the data in the SoCo format

toSchemaKey

public java.lang.String toSchemaKey(java.lang.String cqKey)

Get the schema mapping of a SoCo field. Needed to map CQ fields in a query to Solr fields, since we don't have information about the field type to be able to come up with the Solr name used when adding to index. Custom fields have Solr schema names, so if not found, assume it is a custom dynamic field.

Parameters:

cqKey - The CQ name of a field

Returns:

The Solr index name for the CQ field or the input if not mapped (dynamic field name)

fromSchemaKey

public java.lang.String fromSchemaKey(java.lang.String schemaKey)

Get the CQ mapping of a schema field. Needed to map schema key to CQ field. For facet fields etc, where we don't have a map, just a string.

Parameters:

schemaKey - The schema name of a field

Returns:

The CQ field name or the input if not mapped (dynamic field name)

toSchemaKeys

public java.util.List<java.lang.String> toSchemaKeys(java.lang.String mltField)

Get the schema field name(s) associated with a given SoCo field.

Parameters:

mltField - the SoCo field

Returns:

the list of schema field names

luceneToSolr

public java.lang.String luceneToSolr(java.lang.String luceneQuery)

Convert a lucene query to Solr query Maps the CQ names to Solr names. Handles the path wild card since Solr does not find strings ending in a wildcard if it does not start with a wildcard.

Parameters:

luceneQuery - the lucene query

Returns:

the solr query

toSolrSchema

public abstract java.util.Map<java.lang.String,java.lang.Object> toSolrSchema(java.util.Map<java.lang.String,java.lang.Object> cqFormat,
                                                                              java.lang.String key)

Convert to a format solr likes.

Parameters:

cqFormat - the cq format data

key - the key to convert

Returns:

the converted data