.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35) .\" .\" 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" '' . ds C` . ds C' '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 >0, 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. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Bio::DB::GFF::Typename 3pm" .TH Bio::DB::GFF::Typename 3pm "2020-01-13" "perl v5.30.0" "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::DB::GFF::Typename \-\- The name of a feature type .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Bio::DB::GFF; \& \& my $type = Bio::DB::GFF::Typename\->new(similarity => \*(AqBLAT_EST_GENOME\*(Aq); \& my $segment = $segment\->features($type); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Bio::DB::GFF::Typename objects encapsulate the combination of feature method and source used by the \s-1GFF\s0 flat file format. They can be used in the Bio::DB::GFF modules wherever a feature type is called for. .PP Since there are relatively few types and many features, this module maintains a memory cache of unique types so that two features of the same type will share the same Bio::DB::GFF::Typename object. .SH "METHODS" .IX Header "METHODS" .SS "new" .IX Subsection "new" .Vb 6 \& Title : new \& Usage : $type = Bio::DB::GFF::Typename\->new($method,$source) \& Function: create a new Bio::DB::GFF::Typename object \& Returns : a new Bio::DB::GFF::Typename object \& Args : method and source \& Status : Public .Ve .SS "method" .IX Subsection "method" .Vb 6 \& Title : method \& Usage : $method = $type\->method([$newmethod]) \& Function: get or set the method \& Returns : a method name \& Args : new method name (optional) \& Status : Public .Ve .SS "source" .IX Subsection "source" .Vb 6 \& Title : source \& Usage : $source = $type\->source([$newsource]) \& Function: get or set the source \& Returns : a source name \& Args : new source name (optional) \& Status : Public .Ve .SS "asString" .IX Subsection "asString" .Vb 6 \& Title : asString \& Usage : $string = $type\->asString \& Function: get the method and source as a string \& Returns : a string in "method:source" format \& Args : none \& Status : Public .Ve .PP This method is used by operator overloading to overload the '""' operator. .SS "clone" .IX Subsection "clone" .Vb 6 \& Title : clone \& Usage : $new_clone = $type\->clone; \& Function: clone this object \& Returns : a new Bio::DB::GFF::Typename object \& Args : none \& Status : Public .Ve .PP This method creates an exact copy of the object. .SS "match" .IX Subsection "match" .Vb 6 \& Title : match \& Usage : $boolean = $type\->match($type_or_string) \& Function: fuzzy match on types \& Returns : a flag indicating that the argument matches the object \& Args : a Bio::DB::GFF::typename object, or a string in method:source format \& Status : Public .Ve .PP This match allows Sequence:Link and Sequence: to match, but not Sequence:Link and Sequence:Genomic_canonical. .SH "BUGS" .IX Header "BUGS" This module is still under development. .SH "SEE ALSO" .IX Header "SEE ALSO" bioperl, Bio::DB::GFF, Bio::DB::RelSegment .SH "AUTHOR" .IX Header "AUTHOR" Lincoln Stein . .PP Copyright (c) 2001 Cold Spring Harbor Laboratory. .PP This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.