AlfrescoSQLUtil (OpenContent 3.2.0 Javadoc)

java.lang.Object
- com.tsgrp.opencontent.alfresco.query.AlfrescoSQLUtil

@Component(value="alfrescoSQLUtil")
public class AlfrescoSQLUtil
extends java.lang.Object

Constructor Summary

Constructors
Constructor and Description

AlfrescoSQLUtil()

Constructors
Constructor and Description
`AlfrescoSQLUtil()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addStoreToMap(org.alfresco.util.Pair<java.lang.Long,org.alfresco.service.cmr.repository.StoreRef> storeRefPair)` Add a store to our store map
`static java.lang.String`	`convertAlfrescoDate(java.lang.String millisecondsStr)` Helper function to convert a date (in milliseconds since epoch) to a valid Alfresco date string
`static void`	`ensureSize(java.util.ArrayList<java.lang.Object> list, int size)` Helper function to ensure a list is a certain size
`static java.lang.String`	`getDBColumnName(org.alfresco.service.namespace.QName propertyQName, org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)` Gets the database column name for a property
`static java.lang.String`	`getEncodingByID(java.lang.Long encodingID)` Get an Encoding given the Encoding ID
`static org.alfresco.repo.domain.encoding.EncodingDAO`	`getEncodingDAO()`
`static java.lang.Long`	`getIDbyEncoding(java.lang.String encoding)` Get a Encoding ID given the Encoding
`static java.lang.Long`	`getIDbyLocale(java.util.Locale locale)` Get a Locale ID given the Locale
`static java.lang.Long`	`getIDbyMimetype(java.lang.String mimetype)` Get a Mimetype ID given the Mimetype
`static java.lang.Long`	`getIDbyNodeRef(org.alfresco.service.cmr.repository.NodeRef nodeRef)` Get a NodeRef ID given the NodeRef
`static java.lang.Long`	`getIDbyQName(org.alfresco.service.namespace.QName qName)` Get a QName ID given the QName
`static java.lang.Long`	`getIDbyStoreRef(org.alfresco.service.cmr.repository.StoreRef storeRef)` Get a StoreRef ID given the StoreRef
`static java.util.Locale`	`getLocaleByID(java.lang.Long localeID)` Get a Locale given the Locale ID
`static org.alfresco.repo.domain.locale.LocaleDAO`	`getLocaleDAO()`
`static java.lang.String`	`getMimetypeByID(java.lang.Long mimeTypeID)` Get a Mimetype given the Mimetype ID
`static org.alfresco.repo.domain.mimetype.MimetypeDAO`	`getMimetypeDAO()`
`static org.alfresco.repo.domain.node.NodeDAO`	`getNodeDAO()`
`static org.alfresco.service.cmr.repository.NodeRef`	`getNodeRefByID(java.lang.Long nodeID)` Get a NodeRef given the NodeRef ID
`static java.lang.String`	`getOCName(org.alfresco.service.namespace.QName qName, org.alfresco.service.namespace.NamespaceService namespaceService, AlfrescoEmbDictionaryServiceImpl alfrescoOCDictionaryService)` Gets the OCName of a QName
`static org.alfresco.service.namespace.QName`	`getQNameByID(java.lang.Long qNameID)` Get a QName given the QName ID
`static org.alfresco.repo.domain.qname.QNameDAO`	`getQnameDAO()`
`static org.alfresco.service.cmr.repository.StoreRef`	`getStoreRefByID(java.lang.Long storeID)` Get a StoreRef given the StoreRef ID
`static java.util.List<java.lang.Long>`	`getSubAspectIDsOfAspect(org.alfresco.service.namespace.QName aspectQName, org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)` Gets all the sub aspect IDs of aspect, so when we pass in an aspect we actually query on it and all sub-aspects
`static java.util.List<java.lang.Long>`	`getSubTypeIDsOfType(org.alfresco.service.namespace.QName typeQName, org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)` Gets all the sub type IDs of a type, so when we pass in a type we actually query on all subtypes
`static void`	`postQueryProcess(java.util.List<OpenContentObject> queryResults)` Do any post processing for our results
`void`	`setEncodingReplaceDesignator(java.lang.String encodingReplaceDesignator)`
`void`	`setLocaleReplaceDesignator(java.lang.String localeReplaceDesignator)`
`void`	`setMimetypeReplaceDesignator(java.lang.String mimetypeReplaceDesignator)`
`void`	`setNodeReplaceDesignator(java.lang.String nodeReplaceDesignator)`
`void`	`setQnameReplaceDesignator(java.lang.String qnameReplaceDesignator)`
`void`	`setStoreReplaceDesignator(java.lang.String storeReplaceDesignator)`
`static java.lang.String`	`translateSQLQuery(java.lang.String ticket, java.lang.String query, boolean formatQuery)` Translate Alfresco SQL queries, using query placeholders to mark where we want to insert Alfresco DB IDs We look for placeholders for types/properties/aspects, stores, and mimetypes which will be automatically processed into the corresponding DB ids

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AlfrescoSQLUtil
```
public AlfrescoSQLUtil()
```
- Method Detail
  - getIDbyStoreRef
```
public static java.lang.Long getIDbyStoreRef(org.alfresco.service.cmr.repository.StoreRef storeRef)
```
    Get a StoreRef ID given the StoreRef
    
    Parameters:
    
    storeRef - the StoreRef to look up in the DAO
    
    Returns:
    
    the ID, or -1 if the StoreRef doesn't match an ID
  - getIDbyNodeRef
```
public static java.lang.Long getIDbyNodeRef(org.alfresco.service.cmr.repository.NodeRef nodeRef)
```
    Get a NodeRef ID given the NodeRef
    
    Parameters:
    
    nodeRef - the NodeRef to look up in the DAO
    
    Returns:
    
    the ID, or -1 if the NodeRef doesn't match an ID
  - getIDbyQName
```
public static java.lang.Long getIDbyQName(org.alfresco.service.namespace.QName qName)
```
    Get a QName ID given the QName
    
    Parameters:
    
    qName - the QName to look up in the DAO
    
    Returns:
    
    the ID, or -1 if the QName doesn't match an ID
  - getIDbyMimetype
```
public static java.lang.Long getIDbyMimetype(java.lang.String mimetype)
```
    Get a Mimetype ID given the Mimetype
    
    Parameters:
    
    mimetype - the Mimetype to look up in the DAO
    
    Returns:
    
    the ID, or -1 if the Mimetype doesn't match an ID
  - getIDbyEncoding
```
public static java.lang.Long getIDbyEncoding(java.lang.String encoding)
```
    Get a Encoding ID given the Encoding
    
    Parameters:
    
    encoding - the Encoding to look up in the DAO
    
    Returns:
    
    the ID, or -1 if the Encoding doesn't match an ID
  - getIDbyLocale
```
public static java.lang.Long getIDbyLocale(java.util.Locale locale)
```
    Get a Locale ID given the Locale
    
    Parameters:
    
    locale - the Locale to look up in the DAO
    
    Returns:
    
    the ID, or -1 if the Locale doesn't match an ID
  - getStoreRefByID
```
public static org.alfresco.service.cmr.repository.StoreRef getStoreRefByID(java.lang.Long storeID)
```
    Get a StoreRef given the StoreRef ID
    
    Parameters:
    
    storeID - the ID to look up in the DAO
    
    Returns:
    
    the StoreRef, or null if the ID doesn't match an StoreRef
  - getNodeRefByID
```
public static org.alfresco.service.cmr.repository.NodeRef getNodeRefByID(java.lang.Long nodeID)
```
    Get a NodeRef given the NodeRef ID
    
    Parameters:
    
    nodeID - the ID to look up in the DAO
    
    Returns:
    
    the NodeRef, or null if the ID doesn't match an NodeRef
  - getQNameByID
```
public static org.alfresco.service.namespace.QName getQNameByID(java.lang.Long qNameID)
```
    Get a QName given the QName ID
    
    Parameters:
    
    qNameID - the ID to look up in the DAO
    
    Returns:
    
    the QName, or null if the ID doesn't match an QName
  - getMimetypeByID
```
public static java.lang.String getMimetypeByID(java.lang.Long mimeTypeID)
```
    Get a Mimetype given the Mimetype ID
    
    Parameters:
    
    mimeTypeID - the ID to look up in the DAO
    
    Returns:
    
    the Mimetype, or null if the ID doesn't match an Mimetype
  - getEncodingByID
```
public static java.lang.String getEncodingByID(java.lang.Long encodingID)
```
    Get an Encoding given the Encoding ID
    
    Parameters:
    
    encodingID - the ID to look up in the DAO
    
    Returns:
    
    the Encoding, or null if the ID doesn't match an Encoding
  - getLocaleByID
```
public static java.util.Locale getLocaleByID(java.lang.Long localeID)
```
    Get a Locale given the Locale ID
    
    Parameters:
    
    localeID - the ID to look up in the DAO
    
    Returns:
    
    the Locale, or null if the ID doesn't match a Locale
  - getOCName
```
public static java.lang.String getOCName(org.alfresco.service.namespace.QName qName,
                                         org.alfresco.service.namespace.NamespaceService namespaceService,
                                         AlfrescoEmbDictionaryServiceImpl alfrescoOCDictionaryService)
```
    Gets the OCName of a QName
    
    Parameters:
    
    qName - the QName to get the ocName for
    
    namespaceService - so we can resolve prefixes
    
    alfrescoOCDictionaryService - so we can get our constant name mappings
    
    Returns:
    
    the OC name of the QName
  - addStoreToMap
```
public static void addStoreToMap(org.alfresco.util.Pair<java.lang.Long,org.alfresco.service.cmr.repository.StoreRef> storeRefPair)
```
    Add a store to our store map
    
    Parameters:
    
    storeRefPair - the storeID and storeRef to add
  - ensureSize
```
public static void ensureSize(java.util.ArrayList<java.lang.Object> list,
                              int size)
```
    Helper function to ensure a list is a certain size
    
    Parameters:
    
    list - the list to check
    
    size - the size we are checking against
  - convertAlfrescoDate
```
public static java.lang.String convertAlfrescoDate(java.lang.String millisecondsStr)
                                            throws java.lang.NumberFormatException
```
    Helper function to convert a date (in milliseconds since epoch) to a valid Alfresco date string
    
    Parameters:
    
    millisecondsStr - the milliseconds since epoch
    
    Returns:
    
    the date in IS08601 Date Format
    
    Throws:
    
    java.lang.NumberFormatException - if the incoming string isn't a valid long
  - getSubTypeIDsOfType
```
public static java.util.List<java.lang.Long> getSubTypeIDsOfType(org.alfresco.service.namespace.QName typeQName,
                                                                 org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
```
    Gets all the sub type IDs of a type, so when we pass in a type we actually query on all subtypes
    
    Parameters:
    
    typeQName - the QName to get all subTypes of
    
    dictionaryService - used to get all our subTypes
    
    Returns:
    
    a list of subType QName IDs
  - getSubAspectIDsOfAspect
```
public static java.util.List<java.lang.Long> getSubAspectIDsOfAspect(org.alfresco.service.namespace.QName aspectQName,
                                                                     org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
```
    Gets all the sub aspect IDs of aspect, so when we pass in an aspect we actually query on it and all sub-aspects
    
    Parameters:
    
    aspectQName - the QName to get all sub-aspects of
    
    dictionaryService - used to get all our sub-aspects
    
    Returns:
    
    a list of sub-aspect QName IDs
  - postQueryProcess
```
public static void postQueryProcess(java.util.List<OpenContentObject> queryResults)
```
    Do any post processing for our results
    
    Parameters:
    
    queryResults -
  - getDBColumnName
```
public static java.lang.String getDBColumnName(org.alfresco.service.namespace.QName propertyQName,
                                               org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
```
    Gets the database column name for a property
    
    Parameters:
    
    propertyQName - - The QName for a property
    
    dictionaryService - - An Alfresco DictionaryService
    
    Returns:
    
    the column name for the QName
    
    Throws:
    
    org.alfresco.repo.search.impl.querymodel.QueryModelException - the QName is unrecognized
  - translateSQLQuery
```
public static java.lang.String translateSQLQuery(java.lang.String ticket,
                                                 java.lang.String query,
                                                 boolean formatQuery)
```
    Translate Alfresco SQL queries, using query placeholders to mark where we want to insert Alfresco DB IDs We look for placeholders for types/properties/aspects, stores, and mimetypes which will be automatically processed into the corresponding DB ids
    
    Parameters:
    
    ticket -
    
    query - - A query we want to insert Alfresco DB Ids into
    
    formatQuery - - Do we format the query before returning it
    
    Returns:
    
    A query with Alfresco DB IDs inserted, possibly formatter
  - setNodeReplaceDesignator
```
@Value(value="${sqlQueryTranslator.nodeReplaceDesignator:@node@}")
public void setNodeReplaceDesignator(java.lang.String nodeReplaceDesignator)
```
  - setQnameReplaceDesignator
```
@Value(value="${sqlQueryTranslator.qnameReplaceDesignator:@qname@}")
public void setQnameReplaceDesignator(java.lang.String qnameReplaceDesignator)
```
  - setStoreReplaceDesignator
```
@Value(value="${sqlQueryTranslator.storeReplaceDesignator:@store@}")
public void setStoreReplaceDesignator(java.lang.String storeReplaceDesignator)
```
  - setMimetypeReplaceDesignator
```
@Value(value="${sqlQueryTranslator.mimetypeReplaceDesignator:@mimetype@}")
public void setMimetypeReplaceDesignator(java.lang.String mimetypeReplaceDesignator)
```
  - setEncodingReplaceDesignator
```
@Value(value="${sqlQueryTranslator.encodingReplaceDesignator:@encoding@}")
public void setEncodingReplaceDesignator(java.lang.String encodingReplaceDesignator)
```
  - setLocaleReplaceDesignator
```
@Value(value="${sqlQueryTranslator.localeReplaceDesignator:@locale@}")
public void setLocaleReplaceDesignator(java.lang.String localeReplaceDesignator)
```
  - getNodeDAO
```
public static org.alfresco.repo.domain.node.NodeDAO getNodeDAO()
```
    Returns:
    
    a NodeDAO
  - getQnameDAO
```
public static org.alfresco.repo.domain.qname.QNameDAO getQnameDAO()
```
    Returns:
    
    a QNameDAO
  - getMimetypeDAO
```
public static org.alfresco.repo.domain.mimetype.MimetypeDAO getMimetypeDAO()
```
    Returns:
    
    a MimetypeDAO
  - getEncodingDAO
```
public static org.alfresco.repo.domain.encoding.EncodingDAO getEncodingDAO()
```
    Returns:
    
    an EncodingDAO
  - getLocaleDAO
```
public static org.alfresco.repo.domain.locale.LocaleDAO getLocaleDAO()
```
    Returns:
    
    a LocaleDAO

Class AlfrescoSQLUtil

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AlfrescoSQLUtil

Method Detail

getIDbyStoreRef

getIDbyNodeRef

getIDbyQName

getIDbyMimetype

getIDbyEncoding

getIDbyLocale

getStoreRefByID

getNodeRefByID

getQNameByID

getMimetypeByID

getEncodingByID

getLocaleByID

getOCName

addStoreToMap

ensureSize

convertAlfrescoDate

getSubTypeIDsOfType

getSubAspectIDsOfAspect

postQueryProcess

getDBColumnName

translateSQLQuery

setNodeReplaceDesignator

setQnameReplaceDesignator

setStoreReplaceDesignator

setMimetypeReplaceDesignator

setEncodingReplaceDesignator

setLocaleReplaceDesignator

getNodeDAO

getQnameDAO

getMimetypeDAO

getEncodingDAO

getLocaleDAO