entityimpl.java

xbrlapi的源码

package org.xbrlapi.impl;

import java.util.HashMap;

import org.w3c.dom.Element;
import org.w3c.dom.NodeList;
import org.xbrlapi.Entity;
import org.xbrlapi.EntityResource;
import org.xbrlapi.FragmentList;
import org.xbrlapi.LabelResource;
import org.xbrlapi.Segment;
import org.xbrlapi.utilities.Constants;
import org.xbrlapi.utilities.XBRLException;

/**
 * @author Geoffrey Shuetrim ([e-mail])
 */

public class EntityImpl extends ContextComponentImpl implements Entity {

    /**
     * @see org.xbrlapi.Entity#getIdentifierScheme()
     */
    public String getIdentifierScheme() throws XBRLException {
    	NodeList identifiers = getDataRootElement().getElementsByTagNameNS(Constants.XBRL21Namespace,"identifier");
    	if (identifiers.getLength() == 0) throw new XBRLException("An entity identifier is missing from the entity.");
    	if (identifiers.getLength() > 1) throw new XBRLException("There are too many entity identifiers in the entity.");
    	Element identifier = (Element) identifiers.item(0);
    	if (! identifier.hasAttribute("scheme")) throw new XBRLException("The entity identifier scheme is not specified.");
    	return identifier.getAttribute("scheme");
    }

    /**
     * @see org.xbrlapi.Entity#getIdentifierValue()
     */
    public String getIdentifierValue() throws XBRLException {
    	NodeList identifiers = getDataRootElement().getElementsByTagNameNS(Constants.XBRL21Namespace,"identifier");
    	if (identifiers.getLength() == 0) throw new XBRLException("An entity identifier is missing from the entity.");
    	if (identifiers.getLength() > 1) throw new XBRLException("There are too many entity identifiers in the entity.");
    	Element identifier = (Element) identifiers.item(0);
    	if (! identifier.hasAttribute("scheme")) throw new XBRLException("The entity identifier scheme is not specified.");
    	return identifier.getTextContent();
    }
    

    
    /**
     * @see org.xbrlapi.Entity#getSegment()
     */
    public Segment getSegment() throws XBRLException {
    	FragmentList<Segment> candidates = this.<Segment>getChildren("org.xbrlapi.impl.SegmentImpl");
    	if (candidates.getLength()==0) return null;
    	return candidates.getFragment(0);
    }
    
    /**
     * @see org.xbrlapi.Entity#getEntityResources()
     */
    public FragmentList<EntityResource> getEntityResources() throws XBRLException {
        String query = "/" + Constants.XBRLAPIPrefix + ":" + "fragment[@type='org.xbrlapi.impl.EntityResourceImpl' and " + Constants.XBRLAPIPrefix + ":" + "data[*/@scheme='"+ this.getIdentifierScheme() +"' and */@value='"+ this.getIdentifierValue() +"']" + "]";
        return getStore().<EntityResource>query(query);
    }
    
    /**
     * @see org.xbrlapi.Entity#getEntityLabels()
     */
    public FragmentList<LabelResource> getEntityLabels() throws XBRLException {
        FragmentList<EntityResource> resources = this.getEntityResources();
        FragmentList<LabelResource> labels = new FragmentListImpl<LabelResource>();
        for (EntityResource resource: resources) {
            labels.addAll(resource.getLabels());
        }
        return labels;
    }
    
    /**
     * @see org.xbrlapi.Entity#getAllEntityLabels()
     */
    public FragmentList<LabelResource> getAllEntityLabels() throws XBRLException {
        FragmentList<EntityResource> resources = this.getEntityResources();
        FragmentList<LabelResource> labels = new FragmentListImpl<LabelResource>();
        for (EntityResource resource: resources) {
            FragmentList<EntityResource> equivalents = resource.getEquivalents();
            for (EntityResource equivalent: equivalents) {
                labels.addAll(equivalent.getLabels());
            }
        }

        // Find unique labels
        HashMap<String,LabelResource> map = new HashMap<String,LabelResource>();
        for (LabelResource label: labels) {
            if (!map.containsKey(label.getFragmentIndex())) {
                map.put(label.getFragmentIndex(), label);
            }
        }
        
        // Convert map to a fragment list
        FragmentList<LabelResource> result = new FragmentListImpl<LabelResource>();
        for (LabelResource label: map.values()) {
            result.add(label);
        }
        
        return result;
    }

    

}