XBRLAPI

A Java API for XBRL


org.xbrlapi.grabber
Interface SECGrabber

All Superinterfaces:
Grabber
All Known Implementing Classes:
SecGrabberImpl

public interface SECGrabber
extends Grabber

Defines an SEC XBRL grabber that exposes a lot more information than XBRL resource URIs from an SEC RSS feed.

Author:
Geoff Shuetrim (geoff@galexy.net)

Method Summary
 String getCIK(URI resource)
           
 String getEntityName(URI resource)
           
 String getFilingDate(URI resource)
           
 String getFormType(URI resource)
           
 String getPeriod(URI resource)
           
 URI getWebpage(URI resource)
           
 boolean hasInstance(URI resource)
           
 
Methods inherited from interface org.xbrlapi.grabber.Grabber
getResources
 

Method Detail

hasInstance

boolean hasInstance(URI resource)
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.

getEntityName

String getEntityName(URI resource)
Parameters:
resource - The URI of the XBRL filing.
Returns:
the name of the filing entity.

getCIK

String getCIK(URI resource)
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.

getFormType

String getFormType(URI resource)
Parameters:
resource - The URI of the XBRL filing.
Returns:
the type of filing.

getWebpage

URI getWebpage(URI resource)
Parameters:
resource - The URI of the XBRL filing.
Returns:
the URI of the corresponding web page.

getFilingDate

String getFilingDate(URI resource)
Parameters:
resource - The URI of the XBRL filing.
Returns:
the URI of the corresponding web page in YYYY-MM-DD format.

getPeriod

String getPeriod(URI resource)
Parameters:
resource - The URI of the XBRL filing.
Returns:
the filing period in YYYY-MM-DD format.

Get Java XBRL API implementation at SourceForge.net.