.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Bio::Chado::Schema::Util 3pm" .TH Bio::Chado::Schema::Util 3pm "2012-07-06" "perl v5.14.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Bio::Chado::Schema::Util \- utility functions shared by Bio::Chado::Schema objects .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& sub create_organismprops { \& my ($self, $props, $opts) = @_; \& \& # process opts \& $opts ||= {}; \& $opts\->{cv_name} = \*(Aqorganism_property\*(Aq \& unless defined $opts\->{cv_name}; \& \& return Bio::Chado::Schema::Util\->create_props \& ( properties => $props, \& options => $opts, \& row => $self, \& prop_relation_name => \*(Aqorganismprops\*(Aq, \& ); \& } .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Helper functions used by several schema classes. .PP Important Note: This package is located in the Schema.pm file as secondary package and it haven't a file for itself. Nevertheless, the use will be the same. .SH "PACKAGE METHODS" .IX Header "PACKAGE METHODS" .SS "create_properties" .IX Subsection "create_properties" .Vb 5 \& Usage: *::Util\->create_properties( row => $self, \& properties => { baz => 2, foo => \*(Aqbar\*(Aq }, \& options => { cv_name => autocreate => 0, ...}, \& prop_relation_name => \*(Aqorganismprops\*(Aq, \& ); \& \& Desc : Chado has a number of prop tables with a similar \& structure. This utility function is used by a number of \& modules to create properties in these kinds of tables. \& \& Args : row => the DBIC row object to create properties for, \& prop_relation_name => the DBIC relation name for the \& properties table to operate on, \& e.g. \*(Aqfeatureprops\*(Aq, \& properties => hashref of { propname => value, ...}, \& options => options hashref as: \& { \& autocreate => 0, \& (optional) boolean, if passed, automatically create cv, \& cvterm, and dbxref rows if one cannot be found for the \& given featureprop name. Default false. \& \& cv_name => cv.name to use for the given featureprops. \& Defaults to \*(Aqfeature_property\*(Aq, \& \& db_name => db.name to use for autocreated dbxrefs, \& default \*(Aqnull\*(Aq, \& \& allow_duplicate_values => default false. \& If true, allow duplicate instances of the same cvterm \& and value in the properties of the feature. Duplicate \& values will have different ranks. \& \& dbxref_accession_prefix => optional, default \& \*(Aqautocreated:\*(Aq, \& definitions => optional hashref of: \& { cvterm_name => definition, \& } \& to load into the cvterm table when autocreating cvterms \& } \& Ret : hashref of { propname => new row object in property table } .Ve .SH "AUTHOR" .IX Header "AUTHOR" Robert Buels, .PP Naama Menda,