Bio::EnsEMBL::MetaData::EventInfo Class Reference

Inheritance diagram for Bio::EnsEMBL::MetaData::EventInfo:

List of all members.

---

Class Summary

Synopsis

      my $event_info =
        Bio::EnsEMBL::MetaData::EventInfo->new(
                                   -ENSEMBL_VERSION=>83,
                                   -EG_VERSION=>30,
                                   -DATE=>'2015-12-07');

Description

Object encapsulating information about an event that concerns a metadata object

See-also

Bio::EnsEMBL::MetaData::BaseInfo Bio::EnsEMBL::MetaData::DBSQL::EventInfoAdaptor

Definition at line 26 of file EventInfo.pm.

Available Methods
protected void	_load_child ()
protected void	_preload ()
protected	_unload ()
public Bio::EnsEMBL::MetaData::DBSQL::GenomeInfoAdaptor	adaptor ()
public Int	count_hash_lengths ()
public	count_hash_values ()
public DbID	dbID ()
public String	details ()
public	new ()
public	source ()
public	subject ()
public	timestamp ()
public Hashref	to_hash ()
public String	to_string ()
public String	type ()

---

Method Documentation

protected void Bio::EnsEMBL::MetaData::BaseInfo::_load_child

(

)

[inherited]

  Description: Lazy load method for loading children from database if not initialised
  Arg        : Key to find child data in object hash
  Arg        : Method for loading child data from adaptor()
  Returntype : none
  Exceptions : none
  Caller     : Internal
  Status     : Stable
 

Code:

protected void Bio::EnsEMBL::MetaData::BaseInfo::_preload

(

)

[inherited]

  Description: Ensure all children are loaded (used for hash transformation)
  Returntype : none
  Exceptions : none
  Caller     : Internal
  Status     : Stable
 

Code:

  Description: Remove all children (used after hash transformation to ensure object is minimised)
  Returntype : none
  Exceptions : none
  Caller     : dump_metadata.pl
  Status     : Stable
 

/**

Reimplemented in Bio::EnsEMBL::MetaData::GenomeAssemblyInfo, and Bio::EnsEMBL::MetaData::GenomeInfo.

protected Bio::EnsEMBL::MetaData::BaseInfo::_unload

(

)

[inherited]

Undocumented method

Code:

Reimplemented in Bio::EnsEMBL::MetaData::GenomeAssemblyInfo, and Bio::EnsEMBL::MetaData::GenomeInfo.

public Bio::EnsEMBL::MetaData::DBSQL::GenomeInfoAdaptor Bio::EnsEMBL::MetaData::BaseInfo::adaptor

(

)

[inherited]

  Arg        : (optional) adaptor to set set
  Description: Gets/sets GenomeInfoAdaptor
  Returntype : Bio::EnsEMBL::MetaData::DBSQL::GenomeInfoAdaptor
  Exceptions : none
  Caller     : Internal
  Status     : Stable
 

Code:

Reimplemented in Bio::EnsEMBL::MetaData::GenomeInfo.

public Int Bio::EnsEMBL::MetaData::BaseInfo::count_hash_lengths

(

)

[inherited]

  Description: Sums sizes of arrays found in hash as values
  Arg		 : hashref
  Returntype : integer
  Exceptions : none
  Caller     : internal
  Status     : Stable
 

Code:

Reimplemented in Bio::EnsEMBL::MetaData::GenomeInfo.

public Bio::EnsEMBL::MetaData::BaseInfo::count_hash_values

(

)

[inherited]

Undocumented method

Code:

Reimplemented in Bio::EnsEMBL::MetaData::GenomeInfo.

public DbID Bio::EnsEMBL::MetaData::BaseInfo::dbID

(

)

[inherited]

  Arg        : (optional) dbID to set set
  Description: Gets/sets internal genome_id used as database primary key
  Returntype : dbID string
  Exceptions : none
  Caller     : Bio::EnsEMBL::MetaData::DBSQL::GenomeInfoAdaptor
  Status     : Stable
 

Code:

Reimplemented in Bio::EnsEMBL::MetaData::GenomeInfo.

public String Bio::EnsEMBL::MetaData::EventInfo::details

(

)

  Description: Get/set details of event
  Arg        : (optional) String
  Returntype : String
  Exceptions : none
  Caller     : general
  Status     : Stable
 

Code:

public Bio::EnsEMBL::MetaData::EventInfo::new

(

)

Undocumented method

Code:

Reimplemented from Bio::EnsEMBL::MetaData::BaseInfo.

public Bio::EnsEMBL::MetaData::EventInfo::source

(

)

Undocumented method

Code:

public String Bio::EnsEMBL::MetaData::EventInfo::subject

(

)

Undocumented method

Code:

  Description: Get/set source of event
  Arg        : (optional) String
  Returntype : String
  Exceptions : none
  Caller     : general
  Status     : Stable
 

/**

  Description: Get timestamp of event
  Returntype : String (YYYY-MM-DD HH:MM::SS)
  Exceptions : none
  Caller     : general
  Status     : Stable
 

/**

public Bio::EnsEMBL::MetaData::EventInfo::timestamp

(

)

Undocumented method

Code:

public Hashref Bio::EnsEMBL::MetaData::EventInfo::to_hash

(

)

  Description: Render as plain hash suitable for export as JSON/XML
  Returntype : Hashref
  Exceptions : none
  Caller     : general
  Status     : Stable
 

Code:

Reimplemented from Bio::EnsEMBL::MetaData::BaseInfo.

public String Bio::EnsEMBL::MetaData::EventInfo::to_string

(

)

  Description: Render as string suitable for display
  Returntype : String
  Exceptions : none
  Caller     : general
  Status     : Stable
 

Code:

public String Bio::EnsEMBL::MetaData::EventInfo::type

(

)

  Description: Get/set subject of event
  Arg        : (optional) String
  Returntype : String
  Exceptions : none
  Caller     : general
  Status     : Stable
 

Code:

---

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

• Bio/EnsEMBL/MetaData/EventInfo.pm