railo-context.Component coldbox.system.cache.store.indexers.MetadataIndexer coldbox.system.cache.store.indexers.JDBCMetadataIndexer
This is a utility object that helps object stores keep their items indexed and pretty
Constructor Summary | |
---|---|
init(any fields, any config, any store)
Constructor. |
Method Summary | |
---|---|
any
|
getFields()
Get the bounded fields list. |
any
|
getObjectMetadata(any objectKey)
Get a metadata entry for a specific entry. |
any
|
getObjectMetadataProperty(any objectKey, any property)
Get a specific metadata property for a specific entry. |
any
|
getPoolMetadata()
Get the entire pool reference. |
any
|
getSize()
Get the size of the elements indexed. |
any
|
getSortedKeys(any property, [any sortType='text'], [any sortOrder='asc'])
Get an array of sorted keys for this indexer according to parameters. |
any
|
objectExists(any objectKey)
Check if the metadata entry exists for an object. |
void
|
setFields(any fields)
Override the constructed metadata fields this index is binded to. |
private void
|
validateField(any target)
Validate or thrown an exception on an invalid field. |
Methods inherited from class coldbox.system.cache.store.indexers.MetadataIndexer |
---|
clear, clearAll, getKeys, setObjectMetadata, setObjectMetadataProperty |
Methods inherited from class railo-context.Component |
---|
None |
Constructor Detail |
---|
Constructor
fields
- The list or array of fields to bind this index onconfig
- JDBC Configuration structurestore
- The associated storageMethod Detail |
---|
Get the bounded fields list
getFields
in class
MetadataIndexer
Get a metadata entry for a specific entry. Exception if key not found
getObjectMetadata
in class
MetadataIndexer
objectKey
- The key of the objectGet a specific metadata property for a specific entry
getObjectMetadataProperty
in class
MetadataIndexer
objectKey
- The key of the objectproperty
- The property of the metadata to retrieve, must exist in the binded fields or exception is thrownGet the entire pool reference
getPoolMetadata
in class
MetadataIndexer
Get the size of the elements indexed
getSize
in class
MetadataIndexer
Get an array of sorted keys for this indexer according to parameters
getSortedKeys
in class
MetadataIndexer
property
- The property field to sort the index on. It must exist in the binded fields or exceptionsortType
- The sort ordering: numeric, text or textnocasesortOrder
- The sort order: asc or descCheck if the metadata entry exists for an object
objectExists
in class
MetadataIndexer
objectKey
- The key of the objectOverride the constructed metadata fields this index is binded to
setFields
in class
MetadataIndexer
fields
- The list or array of fields to bind this index onValidate or thrown an exception on an invalid field
validateField
in class
MetadataIndexer
target
- The target field to validate