org.lockss.laaws.rs.model

Class CdxRecords

java.lang.Object

org.lockss.laaws.rs.model.CdxRecords

public class CdxRecords
extends Object

A collection of [Open|Py]Wayback CDX records.

Constructor Summary

Constructors

Constructor and Description
CdxRecords() No-argument constructor to be used when processing PyWayBack requests.
CdxRecords(Map<String,String> openWayBackQuery, String charsetName) Constructor to be used when processing OpenWayBack requests.

Method Summary

Modifier and Type	Method and Description
void	addCdxRecord(CdxRecord cdxRecord) Adds a CDX record to this object.
int	getCdxRecordCount() Provides the count of CDX records in this object.
List<CdxRecord>	getCdxRecords() Provides the CDX records in this object, for testing purposes.
String	toIaText() Provides the representation of this object in Internet Archive format.
String	toJson() Provides the representation of this object in JSON format.
String	toXmlText() Writes the representation of this object in OpenWayback XML format.

Methods inherited from class java.lang.Object

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

Constructor Detail

CdxRecords

public CdxRecords()

No-argument constructor to be used when processing PyWayBack requests.

CdxRecords

public CdxRecords(Map<String,String> openWayBackQuery,
                  String charsetName)

Constructor to be used when processing OpenWayBack requests.

Parameters:

openWayBackQuery - A Map with the OpenWayBack request query elements.

charsetName - A String with the character set name to be used for XML generation.

Method Detail

addCdxRecord

public void addCdxRecord(CdxRecord cdxRecord)

Adds a CDX record to this object.

Parameters:

cdxRecord - A CdxRecord with the CDX record to be added.

getCdxRecordCount

public int getCdxRecordCount()

Provides the count of CDX records in this object.

Returns:

an int with the count of CDX records in this object.

toIaText

public String toIaText()

Provides the representation of this object in Internet Archive format.

Returns:

a String with the representation of this object in Internet Archive format.

toXmlText

public String toXmlText()
                 throws XMLStreamException

Writes the representation of this object in OpenWayback XML format.

Returns:

a String with the representation of this object in OpenWayBack XML format.

Throws:

XMLStreamException - if there are problems writing the XML element.

toJson

public String toJson()

Provides the representation of this object in JSON format.

Returns:

a String with the representation of this object in JSON format.

getCdxRecords

public List<CdxRecord> getCdxRecords()

Provides the CDX records in this object, for testing purposes.

Returns:

a List with the CDX records in this object.