uk.ac.ebi.jmzidml.xml.xxindex
Interface MzIdentMLIndexer


public interface MzIdentMLIndexer


Method Summary
 int getCount(String xpathExpression)
           
 Set<String> getIDsForElement(MzIdentMLElement element)
          Is dependent on the element being indexed and ID mapped.
 List<psidev.psi.tools.xxindex.index.IndexElement> getIndexElements(String xpathExpression)
           
 String getMzIdentMLAttributeXMLString()
           
 String getStartTag(String id, Class clazz)
           
 String getXmlString(String ID, Class clazz)
          A method to retrieve the XML String of a specific XML element, providing the unique ID of the element and the Java mapped Class.
 Iterator<String> getXmlStringIterator(String xpathExpression)
           
 Set<String> getXpath()
          Retrieves all xpath for which an XML element has been recorded.
 boolean isIDmapped(String id, Class clazz)
           
 

Method Detail

getXmlStringIterator

Iterator<String> getXmlStringIterator(String xpathExpression)

getCount

int getCount(String xpathExpression)
Parameters:
xpathExpression - the xpath defining the XML element.
Returns:
the number of XML elements matching the xpath or -1 if no elements were found for the specified xpath.

getXmlString

String getXmlString(String ID,
                    Class clazz)
A method to retrieve the XML String of a specific XML element, providing the unique ID of the element and the Java mapped Class.

Parameters:
ID - the unique ID from the id attribute of a XML element.
clazz - the Java Class representing the XML element.
Returns:
the XML String representation of the requested element.

getIndexElements

List<psidev.psi.tools.xxindex.index.IndexElement> getIndexElements(String xpathExpression)

getXpath

Set<String> getXpath()
Retrieves all xpath for which an XML element has been recorded.

Returns:
a Set of xpath.

getStartTag

String getStartTag(String id,
                   Class clazz)
Parameters:
id - the unique ID (from the id attribute) of an XML element.
clazz - the Java Class representing the element.
Returns:
the compete start tag for the XML element with the specified attributes.

getMzIdentMLAttributeXMLString

String getMzIdentMLAttributeXMLString()

isIDmapped

boolean isIDmapped(String id,
                   Class clazz)

getIDsForElement

Set<String> getIDsForElement(MzIdentMLElement element)
                             throws ConfigurationException
Is dependent on the element being indexed and ID mapped. See configuration of elements (MzIdentMLElement).

Parameters:
element - the element for which to get the IDs.
Returns:
a Set of all IDs of the specified element.
Throws:
ConfigurationException


Copyright © 2012. All Rights Reserved.