NAME

Object::Meta::File - Library to recognise a special directoryname field from the raw data

DESCRIPTION

Object::Meta::File implements a class which adds a name and a directoryname field to the raw data which can be used to index the Object::Meta entries. It works exactly like the Object::Meta::Named class.

Additionally a hash meta data field will be created for indexation and lookup.

The hash meta data field becomes the index field.

METHODS

Constructor

new ( [ DATA ] )

This is the constructor for a new Object::Meta::File object. It creates a new object from raw data which is passed in a hash key / value pairs.

Parameters:

DATA

The raw data which is passed in a hash key / value pairs.

If a name field is present it will be used to index the entry.

If a directoryname field is present it will be passed to the setDirectoryName() method.

See Method Object::Meta::Named::new()

Administration Methods

set ( DATA )

This overrides the base method Object::Meta::Named::set() to recognize the name and directoryname field.

See Method Object::Meta::Named::set()

See Method Object::Meta::set()

setDirectoryName ( [ DIRECTORY ] )

This will create a directoryname field in the raw data.

Parameters:

DIRECTORY

The string value for the directory name of the object.

If DIRECTORY is empty or is undefined it will empty the directoryname field.

If DIRECTORY does not have a trailing slash / it will be added.

Consultation Methods

getDirectoryName ()

Returns the content of the directoryname field.