XBRLAPI

A Java API for XBRL


org.xbrlapi.grabber
Class SecGrabberImpl

java.lang.Object
  extended by org.xbrlapi.grabber.AbstractGrabberImpl
      extended by org.xbrlapi.grabber.SecGrabberImpl
All Implemented Interfaces:
Grabber, SECGrabber

public class SecGrabberImpl
extends AbstractGrabberImpl
implements SECGrabber

Implementation of an XBRL document URI grabber for the SEC RSS feed.

Author:
Geoff Shuetrim (geoff@galexy.net)

Constructor Summary
SecGrabberImpl(URI source)
           
 
Method Summary
 String getCIK(URI resource)
           
 String getEntityName(URI resource)
           
 String getFilingDate(URI resource)
           
 String getFormType(URI resource)
           
 String getPeriod(URI resource)
           
 List<URI> getResources()
           
 URI getWebpage(URI resource)
           
 boolean hasInstance(URI resource)
           
 
Methods inherited from class org.xbrlapi.grabber.AbstractGrabberImpl
getDocument
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SecGrabberImpl

public SecGrabberImpl(URI source)
Method Detail

getResources

public List<URI> getResources()
Specified by:
getResources in interface Grabber
Returns:
a list of URIs of XBRL resources provided by the source.
See Also:
Grabber.getResources()

getCIK

public String getCIK(URI resource)
Specified by:
getCIK in interface SECGrabber
Parameters:
resource - The URI of the XBRL filing.
Returns:
the CIK code of the filing entity, without any leading or trailing spaces. The CIK code is used as the entity identifier in the XBRL filings.
See Also:
SECGrabber.getCIK(java.net.URI)

getEntityName

public String getEntityName(URI resource)
Specified by:
getEntityName in interface SECGrabber
Parameters:
resource - The URI of the XBRL filing.
Returns:
the name of the filing entity.
See Also:
SECGrabber.getEntityName(java.net.URI)

getFilingDate

public String getFilingDate(URI resource)
Specified by:
getFilingDate in interface SECGrabber
Parameters:
resource - The URI of the XBRL filing.
Returns:
the URI of the corresponding web page in YYYY-MM-DD format.
See Also:
SECGrabber.getFilingDate(java.net.URI)

getFormType

public String getFormType(URI resource)
Specified by:
getFormType in interface SECGrabber
Parameters:
resource - The URI of the XBRL filing.
Returns:
the type of filing.
See Also:
SECGrabber.getFormType(java.net.URI)

getPeriod

public String getPeriod(URI resource)
Specified by:
getPeriod in interface SECGrabber
Parameters:
resource - The URI of the XBRL filing.
Returns:
the filing period in YYYY-MM-DD format.
See Also:
SECGrabber.getPeriod(java.net.URI)

getWebpage

public URI getWebpage(URI resource)
Specified by:
getWebpage in interface SECGrabber
Parameters:
resource - The URI of the XBRL filing.
Returns:
the URI of the corresponding web page.
See Also:
SECGrabber.getWebpage(java.net.URI)

hasInstance

public boolean hasInstance(URI resource)
Specified by:
hasInstance in interface SECGrabber
Parameters:
resource - The URI to test for.
Returns:
true if the SEC RSS feed contains a reference to an XBRL instance with the specified URI and false otherwise.
See Also:
SECGrabber.hasInstance(URI)

Get Java XBRL API implementation at SourceForge.net.