NetBioSIG2012 mikesmoot

Architecture for Extension

Michael Smoot Ph.D.Cytoscape Chief Architect

ISMB NetBIO SIG July 13, 2012

Thursday, July 19, 2012

2

Desktop Application written in Java


3Biological Network Visualization + AnalysisThursday, July 19, 2012

4

Free Software - LGPL


5~5000 downloads per monthThursday, July 19, 2012

6


7Photo credit: Samuel L. Livingston

Cytoscape’s most important feature?

Our Plugin App Architecture


8

Builds a community of stakeholders

Apps allow for customization

Primary analysis mechanism


9

AllegroMCODE APCluster APID2NET BioQualiPlugin BLAST2SimilarityGraph BNMatch CABIN CalculateNodeDegree CentiScaPe ChemViz clusterExplorerPlugin clusterMaker ClusterONE ClusterViz COMA CommFinder CyClus3D CyOog cytoHubba Cytomcl DualLayout dynamicXpr EnhancedSearch EnrichmentMap ExprEssence GraMoFoNe GraphletCounter HiderSlider jActiveModules mcl-new MCODE MINE NeMo NetAtlas NetCirChro netMatch NetworkAnalyzer NetworkEvolution OmicsAnalyzer OmicsViz OrthoNets PanGIA PerturbationAnalyzer PinnacleZ RandomNetworks RDFScsape Reactome FIs RemainingDegreeDistribution ReOrientPlugin ShortestPath Plugin SimTrek structureViz TransClust VennDiagramGenerator VistaClaraPlugin WordCloud BiNoM bioCycPlugin BiogridPlugin BiomartClient BioNetBuilder BisoGenet ConsensusPathDBplugin CoryneRegNetLoader CyThesaurus-ID-Mapping CytoSQL DroID Genoscape GPML-Plugin GraphMLReader IntActWSClient iRefScape KGMLReader MetScape MiMIplugin NCBIClient NCBIEntrezGeneUserInterface Pathintegrator PhosphositePlus Web Service Client Module PICRClient PSICQUICUniversalClient ReConn SessionForWeb SFLDLoader StringWSClient Superpathways-Plugin 3DScape AgilentLiteratureSearch Cytoprophet DisGeNET DomainGraph ExpressionCorrelation GeneMANIA MetaNetter M O N E T B i N G O B u b b l e R o u t e r C l u e G O C o m m o n A t t r i b u t e s DisplayNetworkFromFlatFile FluxViz FunNetViz HyperEdgeEditor PiNGO CyGoose C y t o s c a p e R P C G r o o v y S c r i p t i n g E n g i n e J a v a S c r i p t E n g i n e M i S i n k P y t h o n S c r i p t i n g E n g i n e R u b y S c r i p t i n g E n g i n e S c r i p t E n g i n e M a n a g e r addParentNeighbors AdvancedNetworkMerge batchTool BiLayout commandTool coreCommands CyAnimator edgeLengthPlugin edgeLister EpiTrace FERN FM3 GoogleChartFunctions GroupTool MetaNodePlugin2 MultilevelLayoutPlugin NamedSelection NatureProtocolsWorkflow NeighborHighlight NetLink nodeCharts PhyloTree VennDiagrams


10



11



So whatʼs the problem?

12Photo credit: TaekwonweirdoPhoto credit: Dean247


13


14Photo credit: TaekwonweirdoPhoto credit: Dean247


15


16Photo credit: Taekwonweirdo


17


!!! A tangled mess of inter-dependencies

!!! Every public class is part of the API

!!! Backwards compatibility is impossible

!!! Poor deprecation and versioning strategy

18


Is that all?

19


20

!!! Apps canʼt use conflicting libraries

!!! Apps canʼt publish their own APIs


21

Hurts core developers,app writers, and users!


How do we fix this?

22


1. OSGi

2. Semantic Versioning

3. Maven

23


Cytoscape 3.0

24


Cytoscape 3.0 Milestone 5 is available here:

http://cytoscape.org

25




26

OSGi− provides

runtime container

− defines module boundaries

− provides micro service architecture

Cytoscape Application Stack

Java Virtual Machine

OSGi Framework

Cytoscape API Bundle A

Cytoscape API Bundle B

Cytoscape API Bundle C

Lib 1

Lib 2

Cytoscape Impl Bundle A

Cytoscape Impl Bundle C

Cytoscape Impl Bundle B

App 1 App 2 App YApp X


How does OSGi accomplish this?

27


Module = Jar + Metadata

28


Defines what can depend on the module.Export-Packages: org.cytocape.model

29

Defines what the module can depend on.Import-Packages: org.cytoscape.events

Module X Module YModule Z

API 1

API 2

API 3


Independence

30

Module AModule C

Module B

Library X v 1.1

Module K

Module Z

Module M

Library X v 1.2

Every App gets its own Classloader!


μServices

31

xyz IMPL

xyz API

abc IMPL

abc API

Your App

IMPL modules register instances of service interfaces with the Service Registry

Service Registry

Apps depend on classes and service interfaces defined in the API

Apps get on instances of services interfaces from the Service Registry usingONLY the service interfaces!

IMPL modules create instances of service interfaces defined in the API

Cytoscape +

OSGi


OSGienables

Modularity

32Photo credit: Maurice Koop


OSGi enforces Modularity

33Photo credit: BlackmanVision


Semantic Versioning:

34

Version numbers have meaning!


VERSION: major.minor.patch

patch - backwards compatible bug fixes

minor - backwards compatible new features

major - backwards INcompatible changes

35


As long as we version honestly, your app will always work!

36

(At least until the next major version update)

Because versions have a functional meaning, we can reason about ranges

[3.1,4)


37

Maven

Organize

Build

Release


38

1. OSGi

2. Semantic Versioning

3. Maven

- To enable/enforce modularity

- To define how and when changes happen

- To organize, build, and release


1. Clearly define API

2. Enforce separation of API and implementation

3. Clearly define what can change and when

4. Sensible dependencies

5. Make writing and maintaining plugins easy

39


For more information visit:


40




41

NIH GM070743-01

P01 HG005062

P41 RR031228


42


Thank you!

43


Any Questions?

44


45

Climber

No ropes!!!Risks?

Photo credit: notorious d.a.v.

Lose momentum in lengthy rewrite?

Is the new API too limiting?

Porting apps more trouble than itʼs worth?

Is OSGi just too complicated?


NetBioSIG2012 mikesmoot

Technology

Transcript of NetBioSIG2012 mikesmoot