Package eu.clarin.sru.server.fcs

Class XMLStreamWriterHelper

java.lang.Object

eu.clarin.sru.server.fcs.XMLStreamWriterHelper

public class XMLStreamWriterHelper
extends Object

This class provides several helper methods for writing records in the CLARIN-FCS record schema. These methods do not cover the full spectrum of all variations of records that are permitted by the CLARIN-FCS specification.

See Also:

CLARIN FCS specification, section "Operation searchRetrieve"

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	FCS_HITS_MIMETYPE
protected static String	FCS_HITS_NS
protected static String	FCS_HITS_PREFIX
protected static String	FCS_KWIC_MIMETYPE
protected static String	FCS_KWIC_NS
protected static String	FCS_KWIC_PREFIX
protected static String	FCS_NS
protected static String	FCS_PREFIX

Constructor Summary

Constructors

Constructor	Description
XMLStreamWriterHelper()

Method Summary

Modifier and Type	Method	Description
static void	writeEndDataView(XMLStreamWriter writer)	Write the end of a data view (i.e. the </DataView> element).
static void	writeEndResource(XMLStreamWriter writer)	Write the end of a resource (i.e. the </Resource> element).
static void	writeEndResourceFragment(XMLStreamWriter writer)	Write the end of a resource fragment (i.e. the </ResourceFragment> element).
static void	writeHitsDataView(XMLStreamWriter writer, String text, int[] hits, boolean secondIsLength)	Convince method to write a simple HITS data view.
static void	writeHitsDataView(XMLStreamWriter writer, String left, String hit, String right)	Convince method to write a simple HITS data view.
static void	writeKWICDataView(XMLStreamWriter writer, String left, String keyword, String right)	Deprecated. Use the HITS data view instead.
static void	writeResourceWithHitsDataView(XMLStreamWriter writer, String pid, String ref, String text, int[] hits, boolean secondIsLength)	Convince method to write a simple HITS data view.
static void	writeResourceWithHitsDataView(XMLStreamWriter writer, String pid, String ref, String left, String hit, String right)	Convince method for writing a record with a HITS data view.
static void	writeResourceWithHitsDataViewLegacy(XMLStreamWriter writer, String pid, String ref, String left, String hit, String right)	Deprecated. Only use, if you want compatability to legacy FCS applications.
static void	writeResourceWithKWICDataView(XMLStreamWriter writer, String pid, String ref, String left, String keyword, String right)	Deprecated. The the HITS data view instead.
static void	writeStartDataView(XMLStreamWriter writer, String mimetype)	Write the start of a data view (i.e. the <DataView> element).
static void	writeStartResource(XMLStreamWriter writer, String pid, String ref)	Write the start of a resource (i.e. the <Resource> element).
static void	writeStartResourceFragment(XMLStreamWriter writer, String pid, String ref)	Write the start of a resource fragment (i.e. the <ResourceFragment> element).

Methods inherited from class java.lang.Object

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

Field Detail

FCS_NS

protected static final String FCS_NS

See Also:

Constant Field Values

FCS_PREFIX

protected static final String FCS_PREFIX

See Also:

Constant Field Values

FCS_KWIC_NS

protected static final String FCS_KWIC_NS

See Also:

Constant Field Values

FCS_KWIC_PREFIX

protected static final String FCS_KWIC_PREFIX

See Also:

Constant Field Values

FCS_KWIC_MIMETYPE

protected static final String FCS_KWIC_MIMETYPE

See Also:

Constant Field Values

FCS_HITS_NS

protected static final String FCS_HITS_NS

See Also:

Constant Field Values

FCS_HITS_PREFIX

protected static final String FCS_HITS_PREFIX

See Also:

Constant Field Values

FCS_HITS_MIMETYPE

protected static final String FCS_HITS_MIMETYPE

See Also:

Constant Field Values

Constructor Detail

XMLStreamWriterHelper

public XMLStreamWriterHelper()

Method Detail

writeStartResource

public static void writeStartResource(XMLStreamWriter writer,
                                      String pid,
                                      String ref)
                               throws XMLStreamException

Write the start of a resource (i.e. the <Resource> element). Calls to this method need to be balanced with calls to the writeEndResource(XMLStreamWriter) method.

Parameters:

writer - the XMLStreamWriter to be used

pid - the persistent identifier of this resource or null, if not applicable

ref - the reference of this resource or null, if not applicable

Throws:

XMLStreamException - if an error occurred

writeEndResource

public static void writeEndResource(XMLStreamWriter writer)
                             throws XMLStreamException

Write the end of a resource (i.e. the </Resource> element). Calls to this method need to be balanced with calls to the writeStartResource(XMLStreamWriter, String, String) method.

Parameters:

writer - the XMLStreamWriter to be used

Throws:

XMLStreamException - if an error occurred

writeStartResourceFragment

public static void writeStartResourceFragment(XMLStreamWriter writer,
                                              String pid,
                                              String ref)
                                       throws XMLStreamException

Write the start of a resource fragment (i.e. the <ResourceFragment> element). Calls to this method need to be balanced with calls to the writeEndResourceFragment(XMLStreamWriter) method.

Parameters:

writer - the XMLStreamWriter to be used

pid - the persistent identifier of this resource or null, if not applicable

ref - the reference of this resource or null, if not applicable

Throws:

XMLStreamException - if an error occurred

writeEndResourceFragment

public static void writeEndResourceFragment(XMLStreamWriter writer)
                                     throws XMLStreamException

Write the end of a resource fragment (i.e. the </ResourceFragment> element). Calls to this method need to be balanced with calls to the writeStartResourceFragment(XMLStreamWriter, String, String) method.

Parameters:

writer - the XMLStreamWriter to be used

Throws:

XMLStreamException - if an error occurred

writeStartDataView

public static void writeStartDataView(XMLStreamWriter writer,
                                      String mimetype)
                               throws XMLStreamException

Write the start of a data view (i.e. the <DataView> element). Calls to this method need to be balanced with calls to the writeEndResource(XMLStreamWriter) method.

Parameters:

writer - the XMLStreamWriter to be used

mimetype - the MIME type of this data view applicable

Throws:

XMLStreamException - if an error occurred

writeEndDataView

public static void writeEndDataView(XMLStreamWriter writer)
                             throws XMLStreamException

Write the end of a data view (i.e. the </DataView> element). Calls to this method need to be balanced with calls to the writeStartDataView(XMLStreamWriter, String) method.

Parameters:

writer - the XMLStreamWriter to be used

Throws:

XMLStreamException - if an error occurred

writeKWICDataView

@Deprecated
public static void writeKWICDataView(XMLStreamWriter writer,
                                     String left,
                                     String keyword,
                                     String right)
                              throws XMLStreamException

Deprecated.

Use the HITS data view instead.

Convince method to write a KWIC data view. It automatically performs the calls to writeStartDataView(XMLStreamWriter, String) and writeEndDataView(XMLStreamWriter).

Parameters:

writer - the XMLStreamWriter to be used

left - the left context of the KWIC or null if not applicable

keyword - the keyword of the KWIC

right - the right context of the KWIC or null if not applicable

Throws:

XMLStreamException - if an error occurred

writeResourceWithKWICDataView

@Deprecated
public static void writeResourceWithKWICDataView(XMLStreamWriter writer,
                                                 String pid,
                                                 String ref,
                                                 String left,
                                                 String keyword,
                                                 String right)
                                          throws XMLStreamException

Deprecated.

The the HITS data view instead.

Convince method for writing a record with a KWIC data view. The following code (arguments omitted) would accomplish the same result:

 ...
 writeStartResource(...);
 writeKWICDataView(...);
 writeEndResource(...);
 ...
 

Parameters:

writer - the XMLStreamWriter to be used

pid - the persistent identifier of this resource or null, if not applicable

ref - the reference of this resource or null, if not applicable

left - the left context of the KWIC or null if not applicable

keyword - the keyword of the KWIC

right - the right context of the KWIC or null if not applicable

Throws:

XMLStreamException - if an error occurred

writeHitsDataView

public static void writeHitsDataView(XMLStreamWriter writer,
                                     String left,
                                     String hit,
                                     String right)
                              throws XMLStreamException

Convince method to write a simple HITS data view. It automatically performs the calls to writeStartDataView(XMLStreamWriter, String) and writeEndDataView(XMLStreamWriter).

Parameters:

writer - the XMLStreamWriter to be used

left - the left context of the hit or null if not applicable

hit - the actual hit, that will be highlighted

right - the right context of the hit or null if not applicable

Throws:

XMLStreamException - if an error occurred

writeResourceWithHitsDataView

public static void writeResourceWithHitsDataView(XMLStreamWriter writer,
                                                 String pid,
                                                 String ref,
                                                 String left,
                                                 String hit,
                                                 String right)
                                          throws XMLStreamException

Convince method for writing a record with a HITS data view. The following code (arguments omitted) would accomplish the same result:

 ...
 writeStartResource(...);
 writeHitsDataView(...);
 writeEndResource(...);
 ...
 

Parameters:

writer - the XMLStreamWriter to be used

pid - the persistent identifier of this resource or null, if not applicable

ref - the reference of this resource or null, if not applicable

left - the left context of the hit or null if not applicable

hit - the actual hit, that will be highlighted

right - the right context of the hit or null if not applicable

Throws:

XMLStreamException - if an error occurred

writeHitsDataView

public static void writeHitsDataView(XMLStreamWriter writer,
                                     String text,
                                     int[] hits,
                                     boolean secondIsLength)
                              throws XMLStreamException

Convince method to write a simple HITS data view. It automatically performs the calls to writeStartDataView(XMLStreamWriter, String) and writeEndDataView(XMLStreamWriter).

Parameters:

writer - the XMLStreamWriter to be used

text - the text content of the hit

hits - an even-element array containing tuples for the hit markers in the text content

secondIsLength - if true the second element of each tuple in this hits array is interpreted as an length; if false it is interpreted as an end-offset

Throws:

XMLStreamException - if an error occurred

writeResourceWithHitsDataView

public static void writeResourceWithHitsDataView(XMLStreamWriter writer,
                                                 String pid,
                                                 String ref,
                                                 String text,
                                                 int[] hits,
                                                 boolean secondIsLength)
                                          throws XMLStreamException

Convince method to write a simple HITS data view. It automatically performs the calls to writeStartDataView(XMLStreamWriter, String) and writeEndDataView(XMLStreamWriter).

 ...
 writeStartResource(...);
 writeHitsDataView(...);
 writeEndResource(...);
 ...
 

Parameters:

writer - the XMLStreamWriter to be used

pid - the persistent identifier of this resource or null, if not applicable

ref - the reference of this resource or null, if not applicable

text - the text content of the hit

hits - an even-element array containing tuples for the hit markers in the text content

secondIsLength - if true the second element of each tuple in this hits array is interpreted as an length; if false it is interpreted as an end-offset

Throws:

XMLStreamException - if an error occurred

writeResourceWithHitsDataViewLegacy

@Deprecated
public static void writeResourceWithHitsDataViewLegacy(XMLStreamWriter writer,
                                                       String pid,
                                                       String ref,
                                                       String left,
                                                       String hit,
                                                       String right)
                                                throws XMLStreamException

Deprecated.

Only use, if you want compatability to legacy FCS applications.

Convince method for writing a record with a HITS and a KWIC data view. This method is intended for applications that want ensure computability to legacy CLARIN-FCS clients The following code (arguments omitted) would accomplish the same result:

 ...
 writeStartResource(...);
 writeHitsDataView(...);
 writeKWICDataView(...);
 writeEndResource(...);
 ...
 

Parameters:

writer - the XMLStreamWriter to be used

pid - the persistent identifier of this resource or null, if not applicable

ref - the reference of this resource or null, if not applicable

left - the left context of the hit or null if not applicable

hit - the actual hit, that will be highlighted

right - the right context of the hit or null if not applicable

Throws:

XMLStreamException - if an error occurred