Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

tm::synchronizable(3pm) [debian man page]

TM::Synchronizable(3pm) 				User Contributed Perl Documentation				   TM::Synchronizable(3pm)

NAME

       TM::Synchronizable - Topic Maps, trait for synchronizable resources

SYNOPSIS

	  # you write an input/output driver
	  # see for example TM::Synchronizable::MLDBM
	  package My::WhatEver;

	    # provides source_in and/or source_out methods
	    sub source_in  { .... }

	    sub source_out { .... }

	    1;

	  # you construct your map class
	  package MySyncableMap;

	    use TM;
	    use base qw(TM);
	    use Class::Trait qw(TM::ResourceAble TM::Synchronizable My::WhatEver);

	    1;

	  # you then use that
	  my $tm = MySyncableMap (url => 'file:/where/ever');
	  $tm->sync_in;
	  # work with the map, etc...
	  $tm->sync_out;

DESCRIPTION

       This trait implements the abstract synchronization between in-memory topic maps and the resources which are attached to them, i.e. files,
       web pages, etc. whatever can be addressed via a URI.  Consequently, this trait inherits from TM::ResourceAble, although Class::Trait does
       not do this for you (sadly).

       The trait provides the methods "sync_in" and "sync_out" to implement the synchronization. In this process it uses the timestamp of the map
       ("last_mod") and that of the resource "mtime".

       Unfortunately, the granularity of the two are different (at least on current UNIX systems): for the last modification time values from
       Time::HiRes is used. UNIX resources only use an integer.

       Note: This needs a bit of consideration from the user's side.

INTERFACE

   Methods
       sync_in
	   $tm->sync_in

	   This method provides only the main logic, whether a synchronisation from the resource into the in-memory map should occur. If the last
	   modification date of the resource ("mtime") is more recent than that of the map ("last_mod"), then synchronisation from the resource to
	   the in-memory map will be triggered. For this, a method "source_in" has to exist for the map object; that will be invoked.

	   [Since TM 1.53]: Any additional parameters are passed through to the underlying "source_in" method.

       sync_out
	   $tm->sync_out

	   This method provides the logic, whether synchronisation from the in-memory map towards the attached resource should occur or not. If
	   the last modification date of the map ("last_mod") is more recent than that of the resource ("mtime"), then a method "source_out" for
	   the object is triggered.

	   [Since TM 1.53]: Any additional parameters are passed through to the underlying "source_out" method.

SEE ALSO

       TM, TM::ResourceAble

AUTHOR INFORMATION

       Copyright 20(0[6]|10), Robert Barta <drrho@cpan.org>, All rights reserved.

       This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
       http://www.perl.com/perl/misc/Artistic.html

perl v5.10.1							    2012-06-05						   TM::Synchronizable(3pm)

Check Out this Related Man Page

TM::Serializable(3pm)					User Contributed Perl Documentation				     TM::Serializable(3pm)

NAME

       TM::Serializable - Topic Maps, abstract trait for stream (map) based input/output drivers

SYNOPSIS

	 # step 1) you write an input/output driver for a serialized TM format
	 package MyFormat;

	    # provides methods
	    sub deserialize {
		my $self   = shift; # gets current map
		my $stream = shift;
		# .... fill the map with content
	    }

	    sub serialize {
		my $self = shift; # get the map
		# ....
		return ... #serialized content
	    }
	 1;

	 # step 2) construct a subclass of TM using this driver
	 package MapWithMyFormat;

	   use TM;
	   use base qw(TM);
	   use Class::Trait qw(TM::Serializable MyFormat);

	   1;

	 # step 3) use it in your application
	 my $tm = new MapWithMyFormat (url => 'file:map.myformat');
	 $tm->sync_in; # uses MyFormat to parse the content from the file

DESCRIPTION

       This trait implements synchronizable resources using a serialized format. Examples are formats such as AsTMa 1.0, 2.0, LTM, CTM, XTM. The
       only thing these drivers have to provide are the methods "serialize" and "deserialize" which serialize maps to streams and vice-versa.

       This trait provides the implementations for "source_in" and "source_out" triggering "deserialize" and "serialize", respectively.

INTERFACE

   Methods
       source_in
	   Uses the URL attached to the map object to trigger "deserialize" on the stream content behind the resource. All URLs of LWP are
	   supported. If the URI is "io:stdio" then content from STDIN is consumed. This content can be consumed more than once (it is buffered
	   internally), so that you can read several times from "io:stdin" getting the same input.

	   If the resource URI is "io:stdout", then nothing happens.

	   If the resource URI is "null:", then nothing happens.

	   [Since TM 1.53]: Any additional parameters are passed through to the underlying "deserialize" method.

       source_out
	   This method triggers "serialize" on the object. The contents will be copied to the resource identified by the URI attached to the
	   object. At the moment, only "file:" URLs  and "io:stdout" is supported.

	   If the resource URI is "io:stdin", nothing happens.

	   If the resource URI is "null:", nothing happens.

	   If the resource URI is "inline:.." nothing happens.

	   [Since TM 1.53]: Any additional parameters are passed through to the underlying "serialize" method.

SEE ALSO

       TM, TM::Synchronizable

AUTHOR INFORMATION

       Copyright 20(0[2-6]|10), Robert Barta <drrho@cpan.org>, All rights reserved.

       This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
       http://www.perl.com/perl/misc/Artistic.html

perl v5.10.1							    2010-06-05						     TM::Serializable(3pm)
Man Page