Image.java

package ecologylab.bigsemantics.metadata.builtins;

import java.io.File;
import java.util.Date;
import java.util.List;

import ecologylab.bigsemantics.collecting.SemanticsGlobalScope;
import ecologylab.bigsemantics.html.documentstructure.ImageConstants;
import ecologylab.bigsemantics.metadata.builtins.declarations.ImageDeclaration;
import ecologylab.bigsemantics.metadata.scalar.MetadataParsedURL;
import ecologylab.bigsemantics.metametadata.MetaMetadataCompositeField;
import ecologylab.bigsemantics.metametadata.MetaMetadataRepository;
import ecologylab.net.MimeType;
import ecologylab.net.ParsedURL;
import ecologylab.serialization.annotations.simpl_inherit;

/**
 * This is not generated code, but a hand-authored base class in the 
 * Metadata hierarchy. It is hand-authored in order to provide specific functionalities
 **/
@simpl_inherit
public class Image extends ImageDeclaration
implements MimeType, ImageConstants
{
	
//	@mm_name("local_location") 
//	@simpl_scalar
//	private MetadataParsedURL	localLocation;
//	
//	@mm_name("creation_date") 
//	@simpl_scalar
//	private MetadataDate	creationDate;
	
	/**
	 * Number of images that we parsed with an alt-text.
	 */
	public static int		hasAlt;

	public Image()
	{
		super();
	}

	public Image(MetaMetadataCompositeField metaMetadata)
	{
		super(metaMetadata);
	}

	/**
	 * Construct an instance of this, the base document type, and set its location.
	 * 
	 * @param location
	 */
	public Image(ParsedURL location)
	{
		this(MetaMetadataRepository.getBaseDocumentMM());
		setLocation(location);
	}

	@Override
	public void hwSetNavLocation(ParsedURL navLocation)
	{
		this.setNavLocation(navLocation);
		rebuildCompositeTermVector();
	}
	
	public File getLocalLocationAsFile()
	{
		ParsedURL localLocationPurl = getLocalLocation();
		return (localLocationPurl != null) ? localLocationPurl.file() : null;
	}
	
	/**
	 * Does not actually rebuildCompositeTermVector() as date should never contribute to it.
	 * @param date
	 */
	public void hwSetCreationDate(Date date)
	{
		setCreationDate(date);
	}

	/**
	 * Convenience method for type checking related to Image-ness.
	 * Implementation for Image and its subclasses:
	 * 
	 * @return	true
	 */
	@Override
	public boolean isImage()
	{
		return true;
	}
	/**
	 * Construct an ImageClipping object.
	 * 
	 * @param sourceDocument	The CompoundDocument to be listed as the Clipping's source. The one it is a surrogate for.
	 * 												Usually the same as basisDocument, but for a surrogate for X, found in Y, instead uses outlink here.
	 * @param outlink					The Document to be listed as the Clipping's href destination.
	 * @param caption					Caption text extracted from basisDocument.
	 * @param context					Larger paragraph of contextualizing text extracted from basisDocument.
	 * 
	 * @return								New ImageClipping.
	 */
	public ImageClipping constructClipping(Document sourceDocument, Document outlink, String caption, String context)
	{
		SemanticsGlobalScope scope = this.getSemanticsScope();
		if (scope == null) 
			scope = sourceDocument.getSemanticsScope();
		ImageClipping result	= new ImageClipping(scope.IMAGE_CLIPPING_META_METADATA, this, sourceDocument, outlink, caption, context);
		this.addClipping(result);
		
		return result;
	}

	/**
	 * Construct an ImageClipping object. Add it to the basis's Collection<Clipping>.
	 * 
	 * @param basisDocument		The CompoundDocument to add the clipping to. 
	 * @param sourceDocument	The CompoundDocument to be listed as the Clipping's source. The one it is a surrogate for.
	 * 												Usually the same as basisDocument, but for a surrogate for X, found in Y, instead uses outlink here.
	 * @param outlink					The Document to be listed as the Clipping's href destination.
	 * @param caption					Caption text extracted from basisDocument.
	 * @param context					Larger paragraph of contextualizing text extracted from basisDocument.
	 * 
	 * @return								New ImageClipping.
	 */
	public ImageClipping constructClipping(Document basisDocument, Document sourceDocument, Document outlink, String caption, String context)
	{
		ImageClipping result	= constructClipping(sourceDocument, outlink, caption, context);
		if (basisDocument instanceof RichDocument)
			((RichDocument) basisDocument).addClipping( result);
		return result;
	}
	
	public ParsedURL getInternetLocation()
	{
		return super.getLocation();
	}
	
	@Override
	public ParsedURL getLocation()
	{
		ParsedURL localLocation = getLocalLocation();
		if (localLocation != null)
			return localLocation;
		else
		{
			ParsedURL location = super.getLocation();
			if (location != null)
				return location;
			else
			{
				List<MetadataParsedURL> additionalLocations = getAdditionalLocations();
				if (additionalLocations != null && additionalLocations.size() > 0)
					return additionalLocations.get(0).getValue();
			}
		}
		return null;
	}
	
}