org.topoweb.ila.protocol
Class PLinkTypeAttr

java.lang.Object
  |
  +--org.topoweb.ila.protocol.PLinkTypeAttr

All Implemented Interfaces:

NodeConstants, ProtocolConstants

public class PLinkTypeAttr

extends java.lang.Object

implements ProtocolConstants, NodeConstants

Encapsulates the reading and writing of the "link type" attribute.

Author:

Babak Farhang

See Also:

ProtocolConstants.PC_LINK_TYPE, ProtocolConstants.PC_FORELINKS, ProtocolConstants.PC_BACKLINKS, NodeConstants.FORE, NodeConstants.BACK

Field Summary

Fields inherited from interface org.topoweb.ila.protocol.ProtocolConstants

PC_BACKLINK_COUNT, PC_BACKLINKS, PC_CO_BACKLINK_COUNT, PC_CO_FORELINK_COUNT, PC_CONTENT_LENGTH, PC_CONTENT_TYPE, PC_ERROR_CODE, PC_EXPIRATION, PC_FAIL, PC_FIRST, PC_FORELINK_COUNT, PC_FORELINKS, PC_GET_KNOWN, PC_GET_LINK_NODE, PC_GET_LINKS, PC_GET_NODE, PC_HI, PC_HTTP, PC_ID, PC_ILA, PC_INCOMMUNICADO, PC_LAST, PC_LAST_MODIFIED, PC_LINK_NODE, PC_LINK_TYPE, PC_LO, PC_MAX_COUNT, PC_NODE, PC_NODE_SET, PC_OKAY, PC_ORI, PC_PAGE, PC_REGISTER, PC_REQUEST, PC_RESPONSE, PC_SIZE, PC_STATE, PC_STATUS, PC_SYNC_VERSION_ID, PC_SYNC_VERSION_TIMESTAMP, PC_TITLE, PC_USER, PC_USER_AGENT, PC_USER_NAMESPACE, PC_VERSION, PC_VERSION_ID, PC_VERSION_TIMESTAMP

Fields inherited from interface org.topoweb.ila.NodeConstants

BACK, FIRST_PAGE, FORE, LAST_PAGE, LINK_MASK, PAGE_MASK

Constructor Summary

PLinkTypeAttr()

Method Summary

int	readLinkType(org.w3c.dom.Element func) Reads and returns the "link type" from the given element.
void	writeLinkType(int linkType, org.w3c.dom.Element func) Writes the given linkType value in the given element.

Methods inherited from class java.lang.Object

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

Constructor Detail

PLinkTypeAttr

public PLinkTypeAttr()

Method Detail

writeLinkType

public void writeLinkType(int linkType,
                          org.w3c.dom.Element func)
                   throws java.lang.IllegalArgumentException

Writes the given linkType value in the given element.

Parameters:

linkType - the page order (either FORE or BACK)

func - the element into which the attribute is written into

Throws:

java.lang.IllegalArgumentException - if page is neither FORE nor BACK

readLinkType

public int readLinkType(org.w3c.dom.Element func)
                 throws IlaProtocolException

Reads and returns the "link type" from the given element.

Parameters:

func - the element from which the "link type" attribute will be read

Returns:

either FORE or BACK

Throws:

IlaProtocolException - if there is an error