Callable

box.system.cache.store.indexers.concurrent.Callable interface">

Class

ColdBox Platform - WireBox Version 1.2.0

FRAMES

wirebox.system.cache.store.indexers
Class MetadataIndexer

WEB-INF.cftags.component
        wirebox.system.cache.store.indexers.MetadataIndexer

Direct Known Subclasses:: JDBCMetadataIndexer

public class MetadataIndexer
extends WEB-INF.cftags.component
extends WEB-INF.cftags.component

This is a utility object that helps object stores keep their items indexed and pretty

Constructor Summary

init(any fields)
          Constructor

Method Summary

void clear(any objectKey)
          Clear a metadata key

void clearAll()
          Clear the entire metadata map

any getFields()
          Get the bounded fields list

any<array> getKeys()
          Returns an array of the keys stored in the index

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 indexer

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

void setObjectMetadata(any objectKey, any metadata)
          Set the metadata entry for a specific entry

void setObjectMetadataProperty(any objectKey, any property, any value)
          Set a metadata property for a specific entry

private void validateField(any target)
          Validate or thrown an exception on an invalid field

Methods inherited from class WEB-INF.cftags.component

Constructor Summary
`init(any fields)` Constructor

Method Summary
`void`	`clear(any objectKey)` Clear a metadata key
`void`	`clearAll()` Clear the entire metadata map
`any`	`getFields()` Get the bounded fields list
`any<array>`	`getKeys()` Returns an array of the keys stored in the index
`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 indexer
`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
`void`	`setObjectMetadata(any objectKey, any metadata)` Set the metadata entry for a specific entry
`void`	`setObjectMetadataProperty(any objectKey, any property, any value)` Set a metadata property for a specific entry
`private void`	`validateField(any target)` Validate or thrown an exception on an invalid field

Constructor Detail

init

public init(any fields)

Constructor

Parameters:: fields - The list or array of fields to bind this index on

Method Detail

clear

public void clear(any objectKey)

Clear a metadata key

clearAll

public void clearAll()

Clear the entire metadata map

getFields

public any getFields()

Get the bounded fields list

getKeys

public any<array> getKeys()

Returns an array of the keys stored in the index

getObjectMetadata

public any getObjectMetadata(any objectKey)

Get a metadata entry for a specific entry. Exception if key not found

getObjectMetadataProperty

public any getObjectMetadataProperty(any objectKey, any property)

Get a specific metadata property for a specific entry

getPoolMetadata

public any getPoolMetadata()

Get the entire pool reference

getSize

public any getSize()

Get the size of the indexer

getSortedKeys

public any getSortedKeys(any property, [any sortType='text'], [any sortOrder='asc'])

Get an array of sorted keys for this indexer according to parameters

objectExists

public any objectExists(any objectKey)

Check if the metadata entry exists for an object

setFields

public void setFields(any fields)

Override the constructed metadata fields this index is binded to

setObjectMetadata

public void setObjectMetadata(any objectKey, any metadata)

Set the metadata entry for a specific entry

setObjectMetadataProperty

public void setObjectMetadataProperty(any objectKey, any property, any value)

Set a metadata property for a specific entry

validateField

private void validateField(any target)

Validate or thrown an exception on an invalid field

Overview

Package