ecologylab.services.messages.cf
Class DocumentState

java.lang.Object
  ecologylab.generic.Debug
      ecologylab.xml.ElementState
          ecologylab.services.messages.cf.Seed
              ecologylab.services.messages.cf.DocumentState

All Implemented Interfaces:

OptimizationTypes, XMLTranslationExceptionTypes

public class DocumentState
extends Seed

Seed element used to tell combinFormation to process a document. Version for client only:

data slot definitions only with no other functionality.

Author:

andruid

Nested Class Summary

Nested classes/interfaces inherited from class ecologylab.xml.ElementState

ElementState.ClassToCollectionMap, ElementState.DeclarationStyle, ElementState.xml_attribute, ElementState.xml_class, ElementState.xml_classes, ElementState.xml_collection, ElementState.xml_leaf, ElementState.xml_map, ElementState.xml_nested, ElementState.xml_tag

Field Summary

protected boolean	justcrawl If true, then no media should be collected from this document.
protected boolean	justmedia If true, then no links should be collected from this document and fed to the focused web crawler agent.
protected ParsedURL	url URL of the document or container specified for downloading and processing.

Fields inherited from class ecologylab.services.messages.cf.Seed

bias

Fields inherited from class ecologylab.xml.ElementState

CDATA, ESTIMATE_CHARS_PER_FIELD, FLOATING_PRECISION_OFF, MARSHALLING_PARAMS, NORMAL, UTF16, UTF16_LE, UTF8, XML_FILE_HEADER

Fields inherited from interface ecologylab.xml.OptimizationTypes

BAD_FIELD, COLLECTION_ELEMENT, COLLECTION_SCALAR, IGNORED_ATTRIBUTE, IGNORED_ELEMENT, LEAF_NODE_VALUE, MAP_ELEMENT, MAP_SCALAR, NAME_SPACE_ATTRIBUTE, NAME_SPACE_LEAF_NODE, NAME_SPACE_MASK, NAME_SPACE_NESTED_ELEMENT, NAMESPACE_IGNORED_ELEMENT, NAMESPACE_TRIAL_ELEMENT, OTHER_NESTED_ELEMENT, REGULAR_ATTRIBUTE, REGULAR_NESTED_ELEMENT, ROOT, UNSET_TYPE, XMLNS_ATTRIBUTE, XMLNS_IGNORED

Fields inherited from interface ecologylab.xml.XMLTranslationExceptionTypes

FILE_NOT_FOUND, IO_EXCEPTION, NULL_PURL, UNKNOWN

Constructor Summary

DocumentState()

Method Summary

ParsedURL	getUrl()
boolean	isJustcrawl()
boolean	isJustmedia()
void	setJustcrawl(boolean justcrawl)
void	setJustmedia(boolean justmedia)
void	setUrl(ParsedURL url)

Methods inherited from class ecologylab.services.messages.cf.Seed

getBias, setBias

Methods inherited from class ecologylab.xml.ElementState

addNestedElement, addNestedElement, appendTextNodeString, buildDOM, buildDOM, buildDOM, buildDOM, buildDOM, buildDOMFromXMLCharSequence, buildDOMFromXMLString, checkAnnotation, convertNameStyles, createChildHook, fieldToXMLOptimizations, floatingPrecision, getCollection, getElementStateById, getMap, getNestedNameSpace, getTextNodeString, leafElementFieldNames, lookupNestedNameSpace, optimizations, parent, postTranslationProcessingHook, preTranslationProcessingHook, recycle, setDeclarationStyle, setFieldUsingTypeRegistry, setFloatingPrecision, setParent, setUseDOMForTranslateTo, translateFromXML, translateFromXML, translateFromXML, translateFromXML, translateFromXML, translateFromXMLCharSequence, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOMCharSequence, translateFromXMLDOMCharSequence, translateFromXMLRootNode, translateFromXMLSAX, translateFromXMLSAX, translateFromXMLSAX, translateFromXMLSAX, translateFromXMLSAX, translateToDOM, translateToXML, translateToXML, translateToXML, translateToXML, writePrettyXML, writePrettyXML, writePrettyXML

Methods inherited from class ecologylab.generic.Debug

classSimpleName, closeLoggingFile, debug, debug, debug, debug, debugA, debugA, debugA, debugI, debugI, debugI, error, error, getClassName, getClassName, getInteractive, getPackageName, getPackageName, getPackageName, initialize, level, level, level, logToFile, print, print, println, println, println, println, println, println, printlnA, printlnA, printlnA, printlnI, printlnI, printlnI, printlnI, setLoggingFile, show, show, superString, toggleInteractive, toString, toString, warning, warning, weird, weird

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

url

protected ParsedURL url

URL of the document or container specified for downloading and processing.

justcrawl

protected boolean justcrawl

If true, then no media should be collected from this document. Rather, it will be treated as a collection of links, that will be fed to the focused web crawler agent.

justmedia

protected boolean justmedia

If true, then no links should be collected from this document and fed to the focused web crawler agent. Instead, only collect media to form image and text surrogates.

Constructor Detail

DocumentState

public DocumentState()

Method Detail

isJustcrawl

public boolean isJustcrawl()

Returns:

Returns the justcrawl.

setJustcrawl

public void setJustcrawl(boolean justcrawl)

Parameters:

justcrawl - The justcrawl to set.

isJustmedia

public boolean isJustmedia()

Returns:

Returns the justmedia.

setJustmedia

public void setJustmedia(boolean justmedia)

Parameters:

justmedia - The justmedia to set.

getUrl

public ParsedURL getUrl()

Returns:

Returns the url.

setUrl

public void setUrl(ParsedURL url)

Parameters:

url - The url to set.