Accessing Metdata Fields - Revision history

Alan.stiles@open.ac.uk: redirect to corrected typo page

2016-06-03T13:37:41Z

redirect to corrected typo page

2015-09-24T08:47:56Z

typos corrected

2011-10-13T09:36:30Z

‎Rendering a Field

2011-10-13T08:42:43Z

‎Accessing the DataObjs

2011-10-13T08:41:42Z

‎Accessing the DataObjs

2011-10-13T08:40:27Z

2011-10-12T23:41:35Z

2011-10-12T20:04:04Z

2011-10-12T20:03:19Z

Undo revision 10062 by Af05v@ecs.soton.ac.uk (Talk)

2011-10-12T20:02:48Z

Undo revision 10063 by Af05v@ecs.soton.ac.uk (Talk)

@@ Line 137: / Line 137: @@
 my $ds = $dataobj->dataset;
 my @fields = $ds->fields;
-my %fieldvalues;
+my $fieldvalues;
 foreach my $field (@fields)
+{
@@ Line 165: / Line 165: @@
 </pre>
-Data::Dumper is a very useful library that will output the a Perl data structure.  In the above case, the output may look something like this:
+Data::Dumper is a very useful library that will output the Perl data structure.  In the above case, the output may look something like this:
 <pre>
@@ Line 281: / Line 281: @@
 </pre>
-...though note that there may be more than one file in that directory (and documents contain files, which are also first class objects).
+... though note that there may be more than one file in that directory (and documents contain files, which are also first class objects).

← Older revision		Revision as of 09:36, 13 October 2011
Line 249:		Line 249:

	This will call the default render method for the field, and convert the HTML DOM object to text.		This will call the default render method for the field, and convert the HTML DOM object to text.
		+
		+	You can also render a subfield:
		+
		+	<pre>
		+	my $text = EPrints::Utils::tree_to_utf8( $dataobj->render_value('creators_name') );
		+	</pre>

	== Documents ==		== Documents ==

@@ Line 67: / Line 67: @@
 *aggregate data across records
-In this case, a output_list function needs to be created:
+In this case, a output_list function needs to be created.  The example below is from the MultilineCSV export plugin:
 <pre>
@@ Line 113: / Line 113: @@
 This function outputs a header row for the CSV file and then maps a function on to the list which simply calls the output_dataobj function on each item in the list.
-Mapping a function onto a list of objects is the correct way to process the data.
+Mapping a function onto a list of objects is the correct way to process the dataobjs.
 == Accessing DataObj Metadata ==

← Older revision		Revision as of 08:41, 13 October 2011
Line 112:		Line 112:

	This function outputs a header row for the CSV file and then maps a function on to the list which simply calls the output_dataobj function on each item in the list.		This function outputs a header row for the CSV file and then maps a function on to the list which simply calls the output_dataobj function on each item in the list.
		+
		+	Mapping a function onto a list of objects is the correct way to process the data.

	== Accessing DataObj Metadata ==		== Accessing DataObj Metadata ==

@@ Line 43: / Line 43: @@
 </pre>
-Note the output_dataobj function.  In an export plugin, this will be called on every item in the list that is being exported, and the results for all items aggregated and outputted.
+Note the output_dataobj function.  In an export plugin, this will be called on every item in the list that is being exported, and the results for all items concatenated and outputted.
 There are two function calls of particular interest that aid in retrieving and managing data:
@@ Line 57: / Line 57: @@
 </pre>
-== Accessing Metadata ==
+== Accessing the DataObjs ==
 A number of functions exist to aid in accessing and rendering values in a dataobj.

@@ Line 172: / Line 172: @@
 <dl>
-<dt>Simple</dt><dd>Usually a scalar value (though some datatypes return a hashref</dd>
+<dt>Simple
-<dt>Compund</dt><dd>A hashref containing a simple value for each subfield</dd>
+<dd>Usually a scalar value (though some datatypes return a hashref
-<dt>Multiple</dt><dd>An arrayref containing simple or compound metadata fields</dd>
+<dt>Compound
 </dl>
@@ Line 200: / Line 203: @@
 <pre>
-   my $size = 'medium'; #could also be 'small' or 'thumbnail'
+   my $size = 'medium'; #could also be 'small' or 'preview'
    my $icon_url = $doc->icon_url(size => $size);
 </pre>

← Older revision	Revision as of 20:04, 12 October 2011
(No difference)

← Older revision		Revision as of 20:03, 12 October 2011
Line 1:		Line 1:
		+	{{API}}
		+	[[Category:API]]
		+
	This page proves an overview of the API calls you can use to access the data in a DataObj. The example framing this is that of an export plugin.		This page proves an overview of the API calls you can use to access the data in a DataObj. The example framing this is that of an export plugin.

← Older revision		Revision as of 20:02, 12 October 2011
Line 1:		Line 1:
−	~~[[Category:API]]~~
−
	This page proves an overview of the API calls you can use to access the data in a DataObj. The example framing this is that of an export plugin.		This page proves an overview of the API calls you can use to access the data in a DataObj. The example framing this is that of an export plugin.