/ 
Data-Identifier-v0.12
River stage one • 1 direct dependent • 1 total dependent
/ Data::Identifier::Cloudlet

NAME

Data::Identifier::Cloudlet - format independent identifier object

VERSION

version v0.12

SYNOPSIS

use Data::Identifier::Cloudlet;

my Data::Identifier::Cloudlet $cl = Data::Identifier::Cloudlet->new(root => [...] [, entry => [...]]);

my @roots = $cl->entries;
my @entries = $cl->entries;

my $bool = $cl->is_root($entry);
my $bool = $cl->is_entry($entry);

This module implements a cloudlet. A cloudlet is a often a collection of tags (represented by identifiers).

In a cloudlet each tag can only be once. There is no order. Each tag has a boolean attached that indices if it is a root tag. This is used to indicate if a tag is a first level member or was added by means of completion.

Cloudlets are often used to implement tag listings for single items. But they could also be used for example to provide a directory listing.

Note: Two tags are considered equal if their ISE string equals (eq), see "new" for details.

METHODS

new

my Data::Identifier::Cloudlet $cl = Data::Identifier::Cloudlet->new(root => ..., entry => ..., [ %opts ]);

Creates a new cloudlet object.

The following options are supported (all of which are optional but for root):

from

Creates a new cloudlet from another object. If this option is passed root nor entry must be passed.

Currently the following types are supported: Data::Identifier::Cloudlet, Data::Identifier, and arrayrefs.

If the type corresponds to an object that is not a collection the object is taken as per root.

Note: This option is experimental.

root

The root tag or tags. Must be a single object or a arrayref to such an object. This module accepts all types as long as they implement a method alike "ise" in Data::Identifier.

This is true for at least Data::Identifier, Data::TagDB::Tag, Data::URIID::Base (which many Data::URIID related packages inherit from), and File::FStore::Base (as long as they implement "contentise" in File::FStore::Base).

The ISE value returned is internally used as the primary key (for deduplication and equality checks).

If the object does not implement a ISE returning method, it is passed via "new" in Data::Identifier with the from option to convert it to a Data::Identifier.

entry

The list of other (non-root) entries. Accepts the same values as root.

db

A Data::TagDB instance.

extractor

A Data::URIID instance.

fii

A File::Information instance.

store

A File::FStore instance.

as

my $xxx = $cl->as($as, ...);

This method converts the given cloudlet to another type of object.

$as must be a name of the package (containing :: or starting with an uppercase letter), or one of the special values.

Currently the following packages are supported: Data::Identifier::Cloudlet. Other packages might be supported. Packages need to be installed in order to be supported. Also some packages need special options to be passed to be available.

If $cl is or may not be a Data::Identifier::Cloudlet this method tries to convert it to one first. If $cl is a collection without the root/entry flag, then all entries are considered root entries.

If $cl is a $as (see also rawtype below) then $cl is returned as-is, even if $as would not be supported otherwise.

See also: "as" in Data::Identifier.

The following options (all optional) are supported:

autocreate

If the requested type refers to some permanent storage and the object does not exist for the given identifier whether to create a new object or not.

Defaults to false.

db

An instance of Data::TagDB. This is used to create instances of related packages.

default

Same as in "uuid".

extractor

An instance of Data::URIID. This is used to create instances of related packages such as Data::URIID::Result.

fii

An instance of File::Information. This is used to create instances of related packages.

no_defaults

Same as in "uuid".

rawtype

If $as is given as raw then this value is used for $as. This can be used to ease implementation of other methods that are required to accept raw.

store

An instance of File::FStore. This is used to create instances of related packages such as File::FStore::File.

roots

my @roots = $cl->roots;

Returns the list of root tags.

Takes the following (all optional) options:

as

An type to which the returned entries should be converted to. This is implemented by calling "as" in Data::Identifier.

db

A Data::TagDB object passed to "as" in Data::Identifier. Defaults to the value given via "new".

extractor

A Data::URIID object passed to "as" in Data::Identifier. Defaults to the value given via "new".

fii

A File::Information object passed to "as" in Data::Identifier. Defaults to the value given via "new".

store

A File::FStore object passed to "as" in Data::Identifier. Defaults to the value given via "new".

entries

my @entries = $cl->entries;

Returns the list of all entries.

Takes the same options as "roots".

is_root

my $bool = $cl->is_root($tag);

Returns whether or not a given tag is a root tag. Accepts the same type of objects as "new" in root. See there for how the matching is performed.

is_entry

my $bool = $cl->is_entry($tag);

Returns whether or not a given tag is part of the cloudlet. Accepts the same type of objects as "new" in root. See there for how the matching is performed.

db, extractor, fii, store

my Data::TagDB $db        = $cl->db;
my Data::URIID $extractor = $cl->extractor;
my File::Information $fii = $cl->fii;
my File::FStore $store    = $cl->store;

Gets the corresponding object as passed to "new".

If no such object is known, those methods die. This can be changed to return undef by passing undef via default.

The following (all optional) options are supported:

default

The default value to return if the value is unknown.

no_defaults

This option has currently no effect and is ignored.

AUTHOR

Löwenfelsen UG (haftungsbeschränkt) <support@loewenfelsen.net>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2023-2025 by Löwenfelsen UG (haftungsbeschränkt) <support@loewenfelsen.net>.

This is free software, licensed under:

The Artistic License 2.0 (GPL Compatible)