|
ColdBox Platform Version 3.7.0 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.cache.store.indexers.MetadataIndexer
coldbox.system.cache.store.indexers.JDBCMetadataIndexer
public class 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 WEB-INF.cftags.component |
---|
|
Constructor Detail |
---|
public init(any fields, any config, any store)
fields
- The list or array of fields to bind this index onconfig
- JDBC Configuration structurestore
- The associated storageMethod Detail |
---|
public any getFields()
getFields
in class
MetadataIndexer
public any getObjectMetadata(any objectKey)
getObjectMetadata
in class
MetadataIndexer
objectKey
- The key of the objectpublic any getObjectMetadataProperty(any objectKey, any property)
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 thrownpublic any getPoolMetadata()
getPoolMetadata
in class
MetadataIndexer
public any getSize()
getSize
in class
MetadataIndexer
public any getSortedKeys(any property, [any sortType='text'], [any sortOrder='asc'])
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 descpublic any objectExists(any objectKey)
objectExists
in class
MetadataIndexer
objectKey
- The key of the objectpublic void setFields(any fields)
setFields
in class
MetadataIndexer
fields
- The list or array of fields to bind this index onprivate void validateField(any target)
validateField
in class
MetadataIndexer
target
- The target field to validate
|
ColdBox Platform Version 3.7.0 | ||||
FRAMES |