Bio::EnsEMBL::IdMapping::TinyFeature Class Reference

Inheritance diagram for Bio::EnsEMBL::IdMapping::TinyFeature:

Public Member Functions
public Bio::EnsEMBL::IdMapping::TinyFeature	new_fast ()
public Int	id ()
public String	stable_id ()
public Int	version ()
public String	created_date ()
public String	modified_date ()
public String	to_string ()

Detailed Description

Synopsis

This object isn't instantiated. See objects which inherit from it
(TinyGene, TinyTranscript, etc.) for examples.

Description

This is the base class for the lightweight feature objects used by the
stable Id maping application. For performance reasons, these objects
are instantiated using a new_fast() method. The internal implementation
is an arrayref (rather than the more common hashref), which optimises
memory usage.

There are no adaptors to fetch TinyFeatures from the database. You
rather use the normal feature adaptors and then create the TinyFeatures
from the heavy objects you get. The memory saving will therefore mainly
take effect when serialising and reloading these objects.

Also note that TinyFeatures don't have a slice attached to them - all
location information (where required) is stored on the feature object
directly.

Definition at line 30 of file TinyFeature.pm.

Member Function Documentation

created_date()

public String Bio::EnsEMBL::IdMapping::TinyFeature::created_date

(

)

  Arg[1]      : (optional) String - the feature's stable Id creation date
  Description : Getter/setter for the feature's stable Id creation date.
  Return type : String
  Exceptions  : none
  Caller      : Bio::EnsEMBL::IdMapping::Cache
  Status      : At Risk
              : under development

Code:

id()

public Int Bio::EnsEMBL::IdMapping::TinyFeature::id

(

)

  Arg[1]      : (optional) Int - the feature's internal Id ("dbID")
  Description : Getter/setter for the feature's internal Id.
  Return type : Int
  Exceptions  : none
  Caller      : Bio::EnsEMBL::IdMapping::Cache
  Status      : At Risk
              : under development

Code:

modified_date()

public String Bio::EnsEMBL::IdMapping::TinyFeature::modified_date

(

)

  Arg[1]      : (optional) String - the feature's stable Id modification date
  Description : Getter/setter for the feature's stable Id modification date.
  Return type : String
  Exceptions  : none
  Caller      : Bio::EnsEMBL::IdMapping::Cache
  Status      : At Risk
              : under development

Code:

new_fast()

public Bio::EnsEMBL::IdMapping::TinyFeature Bio::EnsEMBL::IdMapping::TinyFeature::new_fast

(

)

  Arg[1]      : Arrayref $array_ref - the arrayref to bless into the new object 
  Description : Constructor.
  Return type : Bio::EnsEMBL::IdMapping::TinyFeature implementing class
  Exceptions  : none
  Caller      : Bio::EnsEMBL::IdMapping::Cache
  Status      : At Risk
              : under development

Code:

stable_id()

public String Bio::EnsEMBL::IdMapping::TinyFeature::stable_id

(

)

  Arg[1]      : (optional) String - the feature's stable Id
  Description : Getter/setter for the feature's stable Id.
  Return type : String
  Exceptions  : none
  Caller      : Bio::EnsEMBL::IdMapping::Cache
  Status      : At Risk
              : under development

Code:

to_string()

public String Bio::EnsEMBL::IdMapping::TinyFeature::to_string

(

)

  Example     :

print LOG "Created ", $f->to_string, "\n";

  Description : Prints a string representation of the feature for debug
                purposes.
  Return type : String
  Exceptions  : none
  Caller      : general
  Status      : At Risk
              : under development

Code:

version()

public Int Bio::EnsEMBL::IdMapping::TinyFeature::version

(

)

  Arg[1]      : (optional) Int - the feature's stable Id version
  Description : Getter/setter for the feature's stable Id version.
  Return type : Int
  Exceptions  : none
  Caller      : Bio::EnsEMBL::IdMapping::Cache
  Status      : At Risk
              : under development

Code:

---

The documentation for this class was generated from the following file:

• ensembl/modules/Bio/EnsEMBL/IdMapping/TinyFeature.pm