com.basistech.rlp
Class ContextParameters

java.lang.Object
  extended by com.basistech.rlp.ContextParameters

public class ContextParameters
extends Object

Parameters for context creation.


Constructor Summary
ContextParameters()
          Default constructor.
 
Method Summary
 Object clone()
          Clones this ContextParameters object.
 long getContextDataLength()
          Retrieves the length of the context definition string.
 String getContextDefinition()
          Returns the contextconfig XML definition that you have defined.
 void setContextDataLength(long length)
          Sets the length of the context definition string.
 void setContextDefinition(File fileOfXML)
          Uses an contextconfig XML file to define an RLP context.
 void setContextDefinition(String XML)
          Uses a contextconfig XML document in the form of an XML string to define an RLP context.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ContextParameters

public ContextParameters()
Default constructor.

Method Detail

setContextDataLength

public void setContextDataLength(long length)
Sets the length of the context definition string.

Parameters:
length - The length of the context definition string.

getContextDataLength

public long getContextDataLength()
Retrieves the length of the context definition string.

Returns:
Length of the context definition string.

setContextDefinition

public void setContextDefinition(String XML)
Uses a contextconfig XML document in the form of an XML string to define an RLP context.

If the document contain an XML declaration with an encoding attribute (optional), the encoding MUST be set to UTF-8. For example: <?xml version='1.0' encoding='utf-8'?>

Parameters:
XML - Contextconfig XML that defines a context.

setContextDefinition

public void setContextDefinition(File fileOfXML)
                          throws IOException
Uses an contextconfig XML file to define an RLP context.

Parameters:
fileOfXML - Contextconfig document that defines a context.
Throws:
IOException - If there are problems reading the file.

getContextDefinition

public String getContextDefinition()
Returns the contextconfig XML definition that you have defined.

Returns:
Context definition.

clone

public Object clone()
Clones this ContextParameters object.

Overrides:
clone in class Object
Returns:
The cloned ContextParameters object.


Copyright © 2004-2008 Basis Technology Corporation. All Rights Reserved.