API:EPrints/DataObj - Revision history

Pod2wiki at 16:41, 10 January 2022

2022-01-10T16:41:07Z

@@ Line 46: / Line 46: @@
   $dataobj = $dataobj-&gt;create_subobject( $fieldname, $epdata );
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 <span style='display:none'>User Comments</span>
@@ Line 113: / Line 135: @@
 ===$self-&gt;{session}===
-The current [[API:EPrints/Repository|EPrints::Repository]]. This use to be  [[API:EPrints/Session|EPrints::Session]] but was replaced in later versions. See [[API:EPrints/BackCompatibility|EPrints::BackCompatibility]].
+The current [[API:EPrints/Repository|EPrints::Repository]]. This use to be [[API:EPrints/Session|EPrints::Session]] but was replaced in later versions. See [[API:EPrints/BackCompatibility|EPrints::BackCompatibility]].
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 125: / Line 147: @@
 ===$self-&gt;{under_construction}===
-A boolean signifying if the data object is currently under  construction and therefore know house-keeping should be carried out  on the data object whilst set.
+A boolean signifying if the data object is currently under construction and therefore know house-keeping should be carried out on the data object whilst set.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>

Pod2wiki at 20:56, 9 January 2022

2022-01-09T20:56:19Z

← Older revision		Revision as of 20:56, 9 January 2022
Line 113:		Line 113:
	===$self->{session}===		===$self->{session}===

	The current [[API:EPrints/Repository\|EPrints::Repository]]. This use to be [[API:EPrints/Session\|EPrints::Session]] but was replaced in later versions. See [[API:EPrints/~~BackCompatability~~\|EPrints::~~BackCompatability~~]].		The current [[API:EPrints/Repository\|EPrints::Repository]]. This use to be [[API:EPrints/Session\|EPrints::Session]] but was replaced in later versions. See [[API:EPrints/BackCompatibility\|EPrints::BackCompatibility]].

	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>		<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>

Pod2wiki at 20:48, 9 January 2022

2022-01-09T20:48:23Z

← Older revision		Revision as of 20:48, 9 January 2022
Line 113:		Line 113:
	===$self->{session}===		===$self->{session}===

	The current ~~<tt>~~EPrints::Session</~~tt>~~.		The current [[API:EPrints/Repository\|EPrints::Repository]]. This use to be [[API:EPrints/Session\|EPrints::Session]] but was replaced in later versions. See [[API:EPrints/BackCompatability\|EPrints::BackCompatability]].

	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>		<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>

Pod2wiki at 17:52, 9 January 2022

2022-01-09T17:52:25Z

← Older revision		Revision as of 17:52, 9 January 2022
Line 55:		Line 55:
	<!-- Pod2Wiki=head_instance_variables -->		<!-- Pod2Wiki=head_instance_variables -->
	==INSTANCE VARIABLES==		==INSTANCE VARIABLES==
			<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
			<span style='display:none'>User Comments</span>
			<!-- Edit below this comment -->


			<!-- Pod2Wiki= -->
			</div>
			<!-- Pod2Wiki=item_$self->{changed} -->
			===$self->{changed}===

			A reference to a hash containing the old values of metadata that has changed since his the data object was last committed.

	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>		<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
	<span style='display:none'>User Comments</span>		<span style='display:none'>User Comments</span>
Line 74:		Line 86:
	<!-- Pod2Wiki= -->		<!-- Pod2Wiki= -->
	</div>		</div>
	<!-- Pod2Wiki=item_$self->{~~session~~} -->		<!-- Pod2Wiki=item_$self->{dataset} -->
	===$self->{~~session~~}===		===$self->{dataset}===

			The [[API:EPrints/DataSet\|EPrints::DataSet]] to which this record belongs.

			<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
			<span style='display:none'>User Comments</span>
			<!-- Edit below this comment -->


			<!-- Pod2Wiki= -->
			</div>
			<!-- Pod2Wiki=item_$self->{non_volatile_change} -->
			===$self->{non_volatile_change}===

	~~The~~ current ~~<tt>EPrints::Session</tt>~~.		A boolean signifying whether the current changes include at least one change to a non-volatile field.

	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>		<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 86:		Line 110:
	<!-- Pod2Wiki= -->		<!-- Pod2Wiki= -->
	</div>		</div>
	<!-- Pod2Wiki=item_$self->{~~dataset~~} -->		<!-- Pod2Wiki=item_$self->{session} -->
	===$self->{~~dataset~~}===		===$self->{session}===

	The ~~[[API:EPrints/DataSet\|~~EPrints::~~DataSet]] to which this record belongs~~.		The current <tt>EPrints::Session</tt>.

	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>		<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 98:		Line 122:
	<!-- Pod2Wiki= -->		<!-- Pod2Wiki= -->
	</div>		</div>
	<!-- Pod2Wiki=item_$self->{~~changed~~} -->		<!-- Pod2Wiki=item_$self->{under_construction} -->
	===$self->{~~changed~~}===		===$self->{under_construction}===

	A ~~reference to a hash containing~~ the ~~old values of metadata that has changed since his~~ the data object ~~was last committed~~.		A boolean signifying if the data object is currently under construction and therefore know house-keeping should be carried out on the data object whilst set.

	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>		<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>

Pod2wiki at 22:38, 8 January 2022

2022-01-08T22:38:41Z

Show changes

Pod2wiki at 22:29, 1 January 2022

2022-01-01T22:29:59Z

@@ Line 1,267: / Line 1,267: @@
 Has alias:
   $dataobj-&gt;remove_object_relations( $target, %relations )
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>

Pod2wiki at 22:20, 1 January 2022

2022-01-01T22:20:02Z

← Older revision		Revision as of 22:20, 1 January 2022
Line 1:		Line 1:
	<!-- Pod2Wiki=_preamble_		<!-- Pod2Wiki=_preamble_
	This page has been automatically generated from the EPrints 3.4 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.		This page has been automatically generated from the EPrints 3.4 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
	-->{{API}}{{Pod2Wiki}}{{API:Source\|file=EPrints/DataObj.pm\|package_name=EPrints::DataObj}}[[Category:API\|DATAOBJ]]<div><!-- Edit below this comment -->		-->{{API}}{{Pod2Wiki}}{{API:Source\|file=EPrints/DataObj.pm\|package_name=EPrints::DataObj}}[[Category:API\|DATAOBJ]][[Category:API:EPrints/DataObj\|DATAOBJ]]<div><!-- Edit below this comment -->

Pod2wiki at 22:12, 1 January 2022

2022-01-01T22:12:03Z

← Older revision		Revision as of 22:12, 1 January 2022
Line 104:		Line 104:

	The [[API:EPrints/DataSet\|EPrints::DataSet]] to which this record belongs.		The [[API:EPrints/DataSet\|EPrints::DataSet]] to which this record belongs.

			<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
			<span style='display:none'>User Comments</span>
			<!-- Edit below this comment -->


			<!-- Pod2Wiki= -->
			</div>
			<!-- Pod2Wiki=head_core_metadata_fields -->
			==CORE METADATA FIELDS==
			NONE

	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>		<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>

Pod2wiki at 22:11, 1 January 2022

2022-01-01T22:11:01Z

← Older revision		Revision as of 22:11, 1 January 2022
Line 76:		Line 76:
	<!-- Pod2Wiki= -->		<!-- Pod2Wiki= -->
	</div>		</div>
	<!-- Pod2Wiki=item_$self->{data}a -->		<!-- Pod2Wiki=item_$self->{data} -->
	===$self->{data}A reference to a hash containing the metadata of this record.~~===~~		===$self->{data}===

			A reference to a hash containing the metadata of this record.

	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>		<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 86:		Line 88:
	<!-- Pod2Wiki= -->		<!-- Pod2Wiki= -->
	</div>		</div>
	<!-- Pod2Wiki=item_$self->{session}~~the~~ -->		<!-- Pod2Wiki=item_$self->{session} -->
	===$self->{session}The current EPrints::Session~~===~~		===$self->{session}===

			The current EPrints::Session

	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>		<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 96:		Line 100:
	<!-- Pod2Wiki= -->		<!-- Pod2Wiki= -->
	</div>		</div>
	<!-- Pod2Wiki=item_$self->{dataset}~~the~~ -->		<!-- Pod2Wiki=item_$self->{dataset} -->
	===$self->{dataset}The [[API:EPrints/DataSet\|EPrints::DataSet]] to which this record belongs.~~===~~		===$self->{dataset}===

			The [[API:EPrints/DataSet\|EPrints::DataSet]] to which this record belongs.

	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>		<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>

Pod2wiki at 22:10, 1 January 2022

2022-01-01T22:10:02Z

← Older revision		Revision as of 22:10, 1 January 2022
Line 1:		Line 1:
	<!-- Pod2Wiki=_preamble_		<!-- Pod2Wiki=_preamble_
	This page has been automatically generated from the EPrints 3.4 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.		This page has been automatically generated from the EPrints 3.4 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
	-->{{API}}{{Pod2Wiki}}{{API:Source\|file=EPrints/DataObj.pm\|package_name=EPrints::DataObj}}[[Category:API~~\|DATAOBJ]][[Category:API:EPrints/DataObj~~\|DATAOBJ]]<div><!-- Edit below this comment -->		-->{{API}}{{Pod2Wiki}}{{API:Source\|file=EPrints/DataObj.pm\|package_name=EPrints::DataObj}}[[Category:API\|DATAOBJ]]<div><!-- Edit below this comment -->


Line 59:		Line 59:

	It is ABSTRACT - its methods should not be called directly.		It is ABSTRACT - its methods should not be called directly.

			<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
			<span style='display:none'>User Comments</span>
			<!-- Edit below this comment -->


			<!-- Pod2Wiki= -->
			</div>
			<!-- Pod2Wiki=head_instance_variables -->
			==INSTANCE VARIABLES==
			<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
			<span style='display:none'>User Comments</span>
			<!-- Edit below this comment -->


			<!-- Pod2Wiki= -->
			</div>
			<!-- Pod2Wiki=item_$self->{data}a -->
			===$self->{data}A reference to a hash containing the metadata of this record.===

			<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
			<span style='display:none'>User Comments</span>
			<!-- Edit below this comment -->


			<!-- Pod2Wiki= -->
			</div>
			<!-- Pod2Wiki=item_$self->{session}the -->
			===$self->{session}The current EPrints::Session===

			<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
			<span style='display:none'>User Comments</span>
			<!-- Edit below this comment -->


			<!-- Pod2Wiki= -->
			</div>
			<!-- Pod2Wiki=item_$self->{dataset}the -->
			===$self->{dataset}The [[API:EPrints/DataSet\|EPrints::DataSet]] to which this record belongs.===

	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>		<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 108:		Line 147:

	$dataobj = EPrints::DataObj->new_from_data( $session, $data, [ $dataset ] )		$dataobj = EPrints::DataObj->new_from_data( $session, $data, [ $dataset ] )
	Construct a new data object based on the <tt>$data</tt> hash reference of ~~metadata~~.		Construct and and returns a new data object based on the <tt>$data</tt> hash reference of metadata.

			This is usually called by [[API:EPrints/DataObj#create_from_data\|create_from_data]] to ensure default values are set for those field values not initially included in <tt>$data</tt> before this method constructs the data object.

	~~Used to create an object~~ from the ~~data retrieved from the database~~.		<tt>$dataset</tt> is determined from the class if not provided.

	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>		<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 136:		Line 177:

	$dataobj = EPrints::DataObj::create( $session, @default_data )		$dataobj = EPrints::DataObj::create( $session, @default_data )
	ABSTRACT.		ABSTRACT

	Create a new object of this type in the database.		Create a new object of this type in the database.
Line 152:		Line 193:
	===create_from_data===		===create_from_data===

	$dataobj = EPrints::DataObj->create_from_data( $session, $data, $dataset )		$dataobj = EPrints::DataObj->create_from_data( $session, $data, [ $dataset ] )
	~~Create~~ a new object of this type in the database.		Creates and returns a new data object of this type in the database.

	<tt>$~~dataset~~</tt> is ~~the dataset it will belong~~ to.		<tt>$data</tt> is a structured hash reference with multiple dimensions to encompass compound, multiple and sub-object field values.

	<tt>$~~data~~</tt> is the data ~~structured as with [[API:EPrints/DataObj#new_from_data\|new_from_data]]~~.		<tt>$dataset</tt> is the dataset to which the new data object will belong. If this is not defined, it is determined from the class.

	This will create sub-objects as well.		This will pull in defaults for unset field values in <tt>$data</tt> before calling [[API:EPrints/DataObj#new_from_data\|new_from_data]]. It will also create any sub-objects as well as the main object.

	Call this via:		Call this via: