locator.java

来自「xbrlapi的源码」· Java 代码 · 共 55 行

package org.xbrlapi;

import java.net.URL;

import org.xbrlapi.utilities.XBRLException;

/**
 * @author Geoffrey Shuetrim ([e-mail])
 */
public interface Locator extends ArcEnd {

	/**
	 * Set metadata about the target of the locator.
	 * This includes, the absolute URL, the target document URL and the XPointer value
	 * used to identify part of the target document.
	 * @throws XBRLException
	 */
	public void setTarget(URL url) throws XBRLException;	
	
    /**
     * Get the raw xlink:href attribute value (before any resolution).
     * @return the value of the xlink:href attribute on the locator.
     * @throws XBRLException if the attribute is missing.
     */
    public String getHref() throws XBRLException;
    

    
    /**
     * Get the single fragment that this locator references.
     * @return the single fragment referenced by the locator or none if none
     * is found.
     * @throws XBRLException
     */
    public Fragment getTargetFragment() throws XBRLException;
    
    /**
     * Get the absolute value of the HREF to the metadata.
     * @return The absolute URL specified by the locator HREF attribute.
     * @throws XBRLException.
     */
    public URL getAbsoluteHref() throws XBRLException;   
    
    /**
     * @return the document URL for the target fragment.
     * @throws XBRLException.
     */
    public URL getTargetDocumentURL() throws XBRLException;    
    
    /**
     * @return the string value of the XPointer element scheme expression from the xlink:href attribute.
     * @throws XBRLException.
     */
    public String getTargetPointerValue() throws XBRLException;    
}