AbstractSchemaMapper ("The Adobe AEM Quickstart and Web Application.")

java.lang.Object
- com.adobe.cq.social.srp.internal.AbstractSchemaMapper

```
public abstract class AbstractSchemaMapper
extends 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 String AS_CQ_DATA

Fields
Modifier and Type	Field and Description
`static String`	`AS_CQ_DATA`

Constructor Summary

Constructors
Constructor and Description

AbstractSchemaMapper()
ctor.

Constructors
Constructor and Description
`AbstractSchemaMapper()` ctor.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`escapeForSolr(String base)` Escape things that need to go to solr.
`abstract void`	`finalizeSchemaMapping(Map<String,Object> socoData, Map<String,Object> schemaMap)` Subclasses can implement this to muck with the mapping before it is actually committed.
`Map<String,Object>`	`fromAttachmentSchema(Map<String,Object> input)` Convert attachment data from the schema to what SoCo expects.
`Map<String,Object>`	`fromSchema(Map<String,Object> schemaData)` Convert the data from schema into the format expected by SoCo.
`static Calendar`	`fromSchemaDate(String key, Object asDate)` Return a Calendar object from a date value in the schema format.
`String`	`fromSchemaKey(String schemaKey)` Get the CQ mapping of a schema field.
`static String`	`getBaseType()`
`abstract Map<String,String>`	`getMapperSpecificKeys()` fetch the keys that are specific to this impl that need to be mapped.
`static String`	`getMutliLingualLanguageKey(String strLanguage)` Returns the translation language specified as the last name in the key path
`abstract String`	`getReportSuite()`
`static String`	`getSchemaApprovedKey()`
`static String`	`getSchemaAttachmentKey()`
`static String`	`getSchemaAttachmentLengthKey()`
`static String`	`getSchemaAttachmentUploadDateKey()`
`static String`	`getSchemaBaseType()`
`static String`	`getSchemaCQData()`
`static String`	`getSchemaDescriptionKey()`
`static String`	`getSchemaFlaggedHiddenKey()`
`static String`	`getSchemaIsDraftKey()`
`static String`	`getSchemaParentIdKey()`
`static String`	`getSchemaProviderIdKey()`
`static String`	`getSchemaResourceTypeKey()`
`static String`	`getSchemaRootCommentSystemKey()`
`static String`	`getSchemaTimestampKey()`
`static String`	`getSocoAddedKey()`
`static String`	`getSocoApprovedKey()`
`static String`	`getSocoAuthorDisplayNameKey()`
`static String`	`getSocoAuthorImageUrlKey()`
`static String`	`getSocoAuthorProfileUrlKey()`
`static String`	`getSocoDescriptionKey()`
`static String`	`getSocoDraftKey()`
`static String`	`getSocoEntityUrlKey()`
`static String`	`getSocoFlaggedHiddenKey()`
`static String`	`getSocoKey()`
`static String`	`getSocoLastModifiedKey()`
`static String`	`getSocoParentIdKey()`
`static String`	`getSocoTallyTimestampKey()`
`static String`	`getTranslationFolderName()`
`static String`	`getUserDatePrefix()`
`String`	`luceneToSolr(String luceneQuery)` Convert a lucene query to Solr query Maps the CQ names to Solr names.
`abstract void`	`setReportSuite(String reportSuite)` set the report suite used in this mapper.
`Map<String,Object>`	`toAttachmentSchema(Map<String,Object> data, String key)` Format a Map using the keys expected by the schema.
`Map<String,Object>`	`toSchema(Map<String,Object> cqFormat, String key)` Map from the cq data format to the format expected by the schema.
`String`	`toSchemaKey(String cqKey)` Get the schema mapping of a SoCo field.
`List<String>`	`toSchemaKeys(String mltField)` Get the schema field name(s) associated with a given SoCo field.
`abstract Map<String,Object>`	`toSolrSchema(Map<String,Object> cqFormat, 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 String AS_CQ_DATA
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AbstractSchemaMapper
```
public AbstractSchemaMapper()
```
    ctor.
- Method Detail
  - getMapperSpecificKeys
```
public abstract Map<String,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 String getReportSuite()
```
    Returns:
    
    the report suite used in this mapper.
  - setReportSuite
```
public abstract void setReportSuite(String reportSuite)
```
    set the report suite used in this mapper.
    
    Parameters:
    
    reportSuite - the report suite
  - getSchemaDescriptionKey
```
public static String getSchemaDescriptionKey()
```
    Returns:
    
    the key used in the db schema that tells the description
  - getSchemaResourceTypeKey
```
public static String getSchemaResourceTypeKey()
```
    Returns:
    
    the key used in the schema to tell the resource type.
  - getSchemaRootCommentSystemKey
```
public static String getSchemaRootCommentSystemKey()
```
    Returns:
    
    the key used in the schema to tell the location of the root comment system.
  - getSocoAuthorDisplayNameKey
```
public static String getSocoAuthorDisplayNameKey()
```
    Returns:
    
    the key used in soco to tell the author's display name.
  - getSocoAuthorImageUrlKey
```
public static String getSocoAuthorImageUrlKey()
```
    Returns:
    
    the key used in the soco to tell the author's avatar url.
  - getSocoAuthorProfileUrlKey
```
public static String getSocoAuthorProfileUrlKey()
```
    Returns:
    
    the key used in the soco to tell the author's avatar url.
  - getSocoEntityUrlKey
```
public static String getSocoEntityUrlKey()
```
    Returns:
    
    the key used in the soco to tell the entity url.
  - getSocoApprovedKey
```
public static String getSocoApprovedKey()
```
    Returns:
    
    the key used in the soco to tell approval status.
  - getSocoFlaggedHiddenKey
```
public static String getSocoFlaggedHiddenKey()
```
    Returns:
    
    the key used in the soco to tell approval status.
  - getSocoDraftKey
```
public static String getSocoDraftKey()
```
  - getSchemaApprovedKey
```
public static String getSchemaApprovedKey()
```
    Returns:
    
    the key used in the schema to tell the approval status.
  - getSchemaFlaggedHiddenKey
```
public static String getSchemaFlaggedHiddenKey()
```
    Returns:
    
    the key used in the schema to tell the approval status.
  - getSchemaIsDraftKey
```
public static String getSchemaIsDraftKey()
```
  - getSchemaParentIdKey
```
public static String getSchemaParentIdKey()
```
    Returns:
    
    the key used in the schema to tell the parent id.
  - getSchemaProviderIdKey
```
public static String getSchemaProviderIdKey()
```
    Returns:
    
    the key used in the schema to tell the provider id.
  - getSchemaTimestampKey
```
public static String getSchemaTimestampKey()
```
    Returns:
    
    the key used in the schema to tell the creation time.
  - getSchemaAttachmentLengthKey
```
public static String getSchemaAttachmentLengthKey()
```
    Returns:
    
    the key used in schema to tell the attachment length.
  - getSchemaAttachmentUploadDateKey
```
public static String getSchemaAttachmentUploadDateKey()
```
    Returns:
    
    the key used in schema to tell the attachment creation time.
  - getSocoAddedKey
```
public static String getSocoAddedKey()
```
    Returns:
    
    the key used in soco to tell the creation time.
  - getSocoParentIdKey
```
public static String getSocoParentIdKey()
```
    Returns:
    
    the key used in soco to tell the parentid.
  - getSocoTallyTimestampKey
```
public static String getSocoTallyTimestampKey()
```
    Returns:
    
    the key used in soco to tell the tally timestamp.
  - getSocoLastModifiedKey
```
public static String getSocoLastModifiedKey()
```
    Returns:
    
    the key used in soco to tell modification date.
  - getSchemaAttachmentKey
```
public static String getSchemaAttachmentKey()
```
    Returns:
    
    the key used in soco to tell if there are attachments.
  - getSocoKey
```
public static String getSocoKey()
```
    Returns:
    
    the key for a piece of ugc.
  - getSocoDescriptionKey
```
public static String getSocoDescriptionKey()
```
    Returns:
    
    the key used in soco to give the description associated with the ugc.
  - escapeForSolr
```
public static String escapeForSolr(String base)
```
    Escape things that need to go to solr.
    
    Parameters:
    
    base - the original string
    
    Returns:
    
    the converted string.
  - getUserDatePrefix
```
public static String getUserDatePrefix()
```
    Returns:
    
    The prefix used to identify non dynamic user date properties.
  - getSchemaBaseType
```
public static String getSchemaBaseType()
```
    Returns:
    
    The social base type.
  - getBaseType
```
public static String getBaseType()
```
    Returns:
    
    The CQ base type.
  - getSchemaCQData
```
public static String getSchemaCQData()
```
  - getTranslationFolderName
```
public static String getTranslationFolderName()
```
    Returns:
    
    The CQ translation folder name.
  - toSchema
```
public Map<String,Object> toSchema(Map<String,Object> cqFormat,
                                   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 String getMutliLingualLanguageKey(String strLanguage)
```
    Returns the translation language specified as the last name in the key path
  - finalizeSchemaMapping
```
public abstract void finalizeSchemaMapping(Map<String,Object> socoData,
                                           Map<String,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 Map<String,Object> toAttachmentSchema(Map<String,Object> data,
                                             String key)
                                      throws 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:
    
    IOException - on failure
  - fromSchemaDate
```
public static Calendar fromSchemaDate(String key,
                                      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 Map<String,Object> fromSchema(Map<String,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 Map<String,Object> fromAttachmentSchema(Map<String,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 String toSchemaKey(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 String fromSchemaKey(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 List<String> toSchemaKeys(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 String luceneToSolr(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 Map<String,Object> toSolrSchema(Map<String,Object> cqFormat,
                                                String key)
```
    Convert to a format solr likes.
    
    Parameters:
    
    cqFormat - the cq format data
    
    key - the key to convert
    
    Returns:
    
    the converted data

Class AbstractSchemaMapper

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

AS_CQ_DATA

Constructor Detail

AbstractSchemaMapper

Method Detail

getMapperSpecificKeys

getReportSuite

setReportSuite

getSchemaDescriptionKey

getSchemaResourceTypeKey

getSchemaRootCommentSystemKey

getSocoAuthorDisplayNameKey

getSocoAuthorImageUrlKey

getSocoAuthorProfileUrlKey

getSocoEntityUrlKey

getSocoApprovedKey

getSocoFlaggedHiddenKey

getSocoDraftKey

getSchemaApprovedKey

getSchemaFlaggedHiddenKey

getSchemaIsDraftKey

getSchemaParentIdKey

getSchemaProviderIdKey

getSchemaTimestampKey

getSchemaAttachmentLengthKey

getSchemaAttachmentUploadDateKey

getSocoAddedKey

getSocoParentIdKey

getSocoTallyTimestampKey

getSocoLastModifiedKey

getSchemaAttachmentKey

getSocoKey

getSocoDescriptionKey

escapeForSolr

getUserDatePrefix

getSchemaBaseType

getBaseType

getSchemaCQData

getTranslationFolderName

toSchema

getMutliLingualLanguageKey

finalizeSchemaMapping

toAttachmentSchema

fromSchemaDate

fromSchema

fromAttachmentSchema

toSchemaKey

fromSchemaKey

toSchemaKeys

luceneToSolr

toSolrSchema