edu.umass.cs.surveyman.survey

Class HTMLDatum

java.lang.Object

edu.umass.cs.surveyman.survey.SurveyDatum

edu.umass.cs.surveyman.survey.HTMLDatum

All Implemented Interfaces:

Serializable, Comparable

public class HTMLDatum
extends SurveyDatum

SurveyDatum subtype representing arbitrary HTML. Questions used to be a mix of HTMLDatums and StringDatums when the RESOURCE column was in use. Now a question is one of an HTMLDatum or StringDatum.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
String	data The normalized HTML String associated with this SurveyDatum.

Fields inherited from class edu.umass.cs.surveyman.survey.SurveyDatum

CUSTOM_DATUM, DEFAULT_SOURCE_COL, SYSTEM_DEFINED, TOTAL_COMPONENTS

Constructor Summary

Constructors

Constructor and Description
HTMLDatum(String html)
HTMLDatum(String html, int row, int col, int index) Takes in a string of purported HTML, parses and normalizes it, and returns an HTMLDatum.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	dataEquals(String data)
boolean	equals(Object c) Two HTMLDatums are equal if they have equal ids.
boolean	isEmpty() Tests whether this component is empty.
static boolean	isHTMLComponent(String data) Tests whether the input data is valid HTML using Jsoup.
protected String	jsonize()
String	toString() A string representation comprised of the identifier and the relative index, for use in debugging and logging.
String	toString(boolean dataOnly) Returns the data contents of the HTMLDatum.

Methods inherited from class edu.umass.cs.surveyman.survey.SurveyDatum

compareTo, getId, getIndex, getSourceCol, getSourceRow, hashCode, html, isCustomDatum, isCustomDatum, jsonize, makeSurveyDatumId, resetId, setIndex

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

data

public final String data

The normalized HTML String associated with this SurveyDatum.

Constructor Detail

HTMLDatum

public HTMLDatum(String html,
         int row,
         int col,
         int index)

Takes in a string of purported HTML, parses and normalizes it, and returns an HTMLDatum. The row and column data is used for debugging and sorting.

Parameters:

html - Arbitrary HTML fragment.

row - Source row.

col - Source column.

HTMLDatum

public HTMLDatum(String html)

Method Detail

isEmpty

public boolean isEmpty()

Description copied from class: SurveyDatum

Tests whether this component is empty.

Specified by:

isEmpty in class SurveyDatum

Returns:

boolean

jsonize

protected String jsonize()

Specified by:

jsonize in class SurveyDatum

isHTMLComponent

public static boolean isHTMLComponent(String data)

Tests whether the input data is valid HTML using Jsoup.

Parameters:

data - Potentially HTML data.

Returns:

boolean indicating whether the input is valid HTML5.

equals

public boolean equals(Object c)

Two HTMLDatums are equal if they have equal ids.

Specified by:

equals in class SurveyDatum

Parameters:

c - Another HTMLDatum.

Returns:

boolean indicating whether this and the input object have equivalent component ids.

dataEquals

public boolean dataEquals(String data)

Specified by:

dataEquals in class SurveyDatum

toString

public String toString()

Description copied from class: SurveyDatum

A string representation comprised of the identifier and the relative index, for use in debugging and logging.

Overrides:

toString in class SurveyDatum

Returns:

String representation.

toString

public String toString(boolean dataOnly)

Returns the data contents of the HTMLDatum.

Parameters:

dataOnly - boolean indicating whether to return data contents only.

Returns:

String representation of the HTMLDatum.