How to use uk.ac.ebi.intact.application.dataConversion.psiDownload

/**
 * Builds an empty PSI document of the specified version.
 *
 * @param session The user session that contains the requested PSI version.
 *
 * @return a XML Document representing an empty PSI document.
 */
public static Document buildPsiDocument( UserSessionDownload session ) {
  return buildPsiDocument( session, null );
}

/**
 * get the value what will be used as ID of the experiment.
 *
 * @param component the component for which we need an ID.
 *
 * @return the ID of the experiment.
 */
private String getParticipantId( UserSessionDownload session, Component component ) {
  long id = session.getParticipantIdentifier( component );
  return "" + id;
}

/**
 * get the value what will be used as ID of the experiment.
 *
 * @param experiment the experiment for which we need an ID.
 *
 * @return the ID of the experiment.
 */
private String getExperimentId( UserSessionDownload session, Experiment experiment ) {
  long id = session.getExperimentIdentifier( experiment );
  return "" + id;
}

/**
 * get the value what will be used as ID of the protein.
 *
 * @param interactor the interactor for which we need an ID.
 *
 * @return the ID of the protein.
 */
private String getInteractorId( UserSessionDownload session, Interactor interactor ) {
  long id = session.getInteractorIdentifier( interactor );
  return "" + id;
}

/**
 * Return the entry element of the PSI document. If the element doesn't exist, it is created.
 *
 * @return the source Element.
 */
public Element getEntryElement() {
  return getEntryElement( false );
}

public UserSessionDownload( PsiVersion psiVersion, Institution source ) {
  this.psiVersion = psiVersion;
  this.source = source;
  psiDocument = PsiDocumentFactory.buildPsiDocument( this, source );
}

/**
 * get the value what will be used as ID of the experiment.
 *
 * @param experiment the experiment for which we need an ID.
 *
 * @return the ID of the experiment.
 */
private String getParticipantId( UserSessionDownload session, Component component ) {
  long id = session.getParticipantIdentifier( component );
  return "" + id;
}

/**
 * get the value what will be used as ID of the experiment.
 *
 * @param experiment the experiment for which we need an ID.
 *
 * @return the ID of the experiment.
 */
private String getExperimentId( UserSessionDownload session, Experiment experiment ) {
  long id = session.getExperimentIdentifier( experiment );
  return "" + id;
}

/**
 * get the value what will be used as ID of the protein.
 *
 * @param protein the protein for which we need an ID.
 *
 * @return the ID of the protein.
 */
private String getProteinId( UserSessionDownload session, Protein protein ) {
  long id = session.getInteractorIdentifier( protein );
  return "" + id;
}

/**
 * Return the entry element of the PSI document. If the element doesn't exist, it is created.
 *
 * @return the source Element.
 */
public Element getEntryElement() {
  return getEntryElement( false );
}

/**
 * Builds an empty PSI document of the specified version.
 *
 * @param session The user session that contains the requested PSI version.
 *
 * @return a XML Document representing an empty PSI document.
 */
public static Document buildPsiDocument(UserSessionDownload session) {
  return buildPsiDocument(session, null);
}

/**
 * get the value what will be used as ID of the experiment.
 *
 * @param experiment the experiment for which we need an ID.
 *
 * @return the ID of the experiment.
 */
private String getParticipantId( UserSessionDownload session, Component component ) {
  long id = session.getParticipantIdentifier( component );
  return "" + id;
}

/**
 * get the value what will be used as ID of the experiment.
 *
 * @param experiment the experiment for which we need an ID.
 *
 * @return the ID of the experiment.
 */
private String getExperimentId( UserSessionDownload session, Experiment experiment ) {
  long id = session.getExperimentIdentifier( experiment );
  return "" + id;
}

/**
 * get the value what will be used as ID of the protein.
 *
 * @param interactor the interactor for which we need an ID.
 *
 * @return the ID of the protein.
 */
private String getInteractorId( UserSessionDownload session, Interactor interactor ) {
  long id = session.getInteractorIdentifier( interactor );
  return "" + id;
}

/**
 * Builds an empty PSI document of the specified version.
 *
 * @param session The user session that contains the requested PSI version.
 *
 * @return a XML Document representing an empty PSI document.
 */
public static Document buildPsiDocument( UserSessionDownload session ) {
  return buildPsiDocument( session, null );
}

/**
 * get the value what will be used as ID of the experiment.
 *
 * @param experiment the experiment for which we need an ID.
 *
 * @return the ID of the experiment.
 */
private String getParticipantId( UserSessionDownload session, Component component ) {
  long id = session.getParticipantIdentifier( component );
  return "" + id;
}

/**
 * get the value what will be used as ID of the experiment.
 *
 * @param experiment the experiment for which we need an ID.
 *
 * @return the ID of the experiment.
 */
private String getExperimentId( UserSessionDownload session, Experiment experiment ) {
  long id = session.getExperimentIdentifier( experiment );
  return "" + id;
}

public UserSessionDownload( PsiVersion psiVersion, Institution source ) {
  this.psiVersion = psiVersion;
  this.source = source;
  psiDocument = PsiDocumentFactory.buildPsiDocument( this, source );
}

/**
 * get the value what will be used as ID of the experiment.
 *
 * @param experiment the experiment for which we need an ID.
 *
 * @return the ID of the experiment.
 */
private String getParticipantId( UserSessionDownload session, Component component ) {
  long id = session.getParticipantIdentifier( component );
  return "" + id;
}

/**
 * Return a PSI document. Create a new wmpty one if it doesn't exists yet.
 *
 * @return a PSI document.
 */
public Document getPsiDocument() {
  if ( psiDocument == null ) {
    psiDocument = PsiDocumentFactory.buildPsiDocument( this );
  }
  return psiDocument;
}