/**
 * 
 */
package ecologylab.bigsemantics.seeding;

import ecologylab.bigsemantics.collecting.Seeding;
import ecologylab.bigsemantics.collecting.SemanticsGlobalScope;
import ecologylab.net.ParsedURL;
import ecologylab.serialization.annotations.simpl_scalar;

/**
 * Specification of a directive to the agent or otherwise to compositon space services.
 * 
 * Version for client only:
 * 	<li>data slot definitions only with no other functionality.</li>
 * 
 * @author andruid
 */
public class Crawler extends Seed
{
	/**
	 * URL that the action operates on.
	 */
	@simpl_scalar
	protected					ParsedURL	url;
	
	/**
	 * The domain -- for reject actions only.
	 */
	@simpl_scalar
	protected					String		domain;
	
	/**
	 * What is the web crawler being told to do?
	 * 		traversable, untraversable, or reject.
	 */
	@simpl_scalar
	protected					String		action;

	public Crawler()
	{
		super();
	}
	
	/**
	 * Check the validity of this seed.
	 */
	public boolean validate()
	{
		boolean result = false;
		if (REJECT.equals(action))
		{
			String arg	= domain;
			if (arg == null)
			{
				if (url != null)
				{
					arg	= url.domain();
					domain	= arg;
				}
			}
			if (arg != null)
				result = true;
		}

		else if (url != null)
			result = true;
		
		return result;
	}
	
	
	/**
	 * Bring this seed into the agent or directly into the composition.
	 * 
	 * @param infoCollector 
	 */
	public void performInternalSeedingSteps(SemanticsGlobalScope infoCollector)
 	{
		Seeding seeding	= infoCollector.getSeeding();

 	   if (REJECT.equals(action))
 	  	seeding.reject(domain);

  	   else if (url != null)
 	   {
		   if (TRAVERSABLE.equals(action))
		  	 seeding.traversable(url);

		   else if (UNTRAVERSABLE.equals(action))
		  	 seeding.untraversable(url);
 	   }
 	}

	/**
	 * Set the value of the purl field, if the String is valid, 
	 * or (assume) and set the value to be the domain.
	 * 
	 * @param value
	 */
	public boolean setValue(String value)
	{
		ParsedURL trialValue	= ParsedURL.getAbsolute(value, "error parsing from seed");
		boolean result			= (trialValue != null);
		if (result)
			url					= trialValue;
		else
		{
			domain				= value;
			debug("Assuming value from seed is the domain");
		}
		return true;
	}
 	
 	/**
	 * The String the dashboard needs to show.
	 * 
	 * @return	The search query.
	 */
	public String valueString()
	{
		return (domain != null) ? domain : url.toString();
	}


	
	public ParsedURL purl()
	{
		return url;
	}

	public boolean canChangeVisibility()
	{
		return true;
	}

	public boolean isDeletable()
	{
		return true;
	}

	public boolean isEditable()
	{
		return true;
	}

	public boolean isRejectable()
	{
		return true;
	}


	
}