Docs For Class StructuredMetaDataTagGenerator

Class StructuredMetaDataTagGenerator

Description

This is a singleton class that handles auto-generation of tags from structured metadata

version: $Id: StructuredMetaDataTagGenerator.class.php,v 1.5 2007/09/04 20:25:29 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College
since: 11/21/06

Located in /harmoni/core/Tagging/StructuredMetaDataTagGenerator.class.php (line 24)

Method Summary

void StructuredMetaDataTagGenerator ()

void addPartStructureIdForTagGeneration (object Id $repositoryId, object Id $partStructureId)

integer getDatabaseIndex ()

object IdIterator getPartStructureIdsForTagGeneration (object Id $repositoryId)

object StructuredMetaDataTagGenerator instance ()

void regenerateTagsForAsset (object Asset $asset, mixed $agentId, string $system, [optional $repositoryId = null], object Id $agent)

void regenerateTagsForAssets (mixed $assets, mixed $agentId, string $system, [optional $repositoryId = null], object Id $agent)

void regenerateTagsForRepository (object Id $repositoryId, mixed $agentId, string $system, object Id $agent)

void removePartStructureIdForTagGeneration (object Id $repositoryId, mixed $partStructureId)

boolean shouldGenerateTagsForPartStructure (object Id $repositoryId, object Id $partStructureId)

Methods

Constructor StructuredMetaDataTagGenerator (line 52)

The constructor.

access: public

void StructuredMetaDataTagGenerator ()

addPartStructureIdForTagGeneration (line 141)

Add a PartStructureId for which Tags should be auto-generated, in the given repository

since: 11/21/06
access: public

void addPartStructureIdForTagGeneration (object Id $repositoryId, object Id $partStructureId)

object Id $repositoryId
object Id $partStructureId

getDatabaseIndex (line 293)

Answer the database index

since: 11/6/06
access: public

integer getDatabaseIndex ()

getPartStructureIdsForTagGeneration (line 87)

Answer the PartStructure Ids for which Tags should be auto-generated, in the given repository.

since: 11/21/06
access: public

object IdIterator getPartStructureIdsForTagGeneration (object Id $repositoryId)

object Id $repositoryId

instance (line 38)

Get the instance of StructuredMetaDataTagGenerator.

The StructuredMetaDataTagGenerator class implements the Singleton pattern. There is only ever one instance of the StructuredMetaDataTagGenerator object and it is accessed only via the StructuredMetaDataTagGenerator::instance() method.

static:
since: 5/26/05
access: public

object StructuredMetaDataTagGenerator instance ()

regenerateTagsForAsset (line 260)

Regenerate tags for a single Asset

since: 11/27/06
access: public

void regenerateTagsForAsset (object Asset $asset, mixed $agentId, string $system, [optional $repositoryId = null], object Id $agent)

object Asset $asset
object Id $agent: Id The agent id to associate with these tags
string $system: The system to associate with these tags
optional $repositoryId: object Id $repositoryId Not required, but can enhance efficiency if it is known ahead of time.

regenerateTagsForAssets (line 217)

Regenerate tags for a number of assets

since: 11/27/06
access: public

void regenerateTagsForAssets (mixed $assets, mixed $agentId, string $system, [optional $repositoryId = null], object Id $agent)

mixed $assets: An AssetIterator, an array of Assets, or a single Asset
object Id $agent: Id The agent id to associate with these tags
string $system: The system to associate with these tags
optional $repositoryId: object Id $repositoryId Not required, but can enhance efficiency if it is known ahead of time.

regenerateTagsForRepository (line 198)

Regenerate tags for all assets in the given repository

since: 11/27/06
access: public

void regenerateTagsForRepository (object Id $repositoryId, mixed $agentId, string $system, object Id $agent)

object Id $repositoryId
object Id $agent: Id The agent id to associate with these tags
string $system: The system to associate with these tags

removePartStructureIdForTagGeneration (line 168)

Add a PartStructureId for which Tags should be auto-generated, in the given repository

since: 11/21/06
access: public

void removePartStructureIdForTagGeneration (object Id $repositoryId, mixed $partStructureId)

object Id $repositoryId

shouldGenerateTagsForPartStructure (line 120)

Answer true if the PartStructure should have tags auto-generated for it in the given repository.

since: 11/21/06
access: public

boolean shouldGenerateTagsForPartStructure (object Id $repositoryId, object Id $partStructureId)

object Id $repositoryId
object Id $partStructureId

Documentation generated on Wed, 19 Sep 2007 10:26:55 -0400 by phpDocumentor 1.3.0RC3