com.ibm.rfid.premises.app.entities.supplychain.printing
Class LabelList

java.lang.Object
  extended by com.ibm.rfid.premises.app.entities.AbstractXmlObject
      extended by com.ibm.rfid.premises.app.entities.supplychain.printing.LabelList

public class LabelList
extends AbstractXmlObject

This represents a group of Label objects and also sets default properties for them. Properties (FormData) found at the Label object level override the default FormData set in LabelList.


Field Summary
static java.lang.String LABEL_LIST
          xml tag name used to describe a LabelList
 
Fields inherited from class com.ibm.rfid.premises.app.entities.AbstractXmlObject
attributes_, EQ, GT, LT, QUOTE, SLASH, tagName_, XML_START
 
Constructor Summary
LabelList()
          Basic Constructor
LabelList(java.lang.String xml)
          Creates a LabelList using the specified XML string
 
Method Summary
 void addDefaultFormData(FormData fd)
          Adds default form data to the LabelList
 void addDefaultFormData(java.lang.String name, java.lang.String value)
          Adds default form data to the LabelList
 void addLabel(Label label)
          Adds a label
 FormData getDefaultFormData(java.lang.String name)
          Returns a FormData with the name specified by the parameter.
 java.util.Enumeration getDefaultFormDatas()
          Gets the default form datas
 java.lang.String getDefaultTemplateBarcodeKey()
          Gets the default template barcode key
 java.lang.String getDefaultTemplateEpcKey()
          Gets the default templace EPC key
 java.lang.String getDefaultTemplateName()
          Gets the default template name
 Label getLabel(int i)
          Gets a specified label
 int getLabelListSize()
          Gets the number of labels in the LabelList
 void setDefaultTemplateBarcodeKey(java.lang.String s)
          Sets the new default template barcode key
 void setDefaultTemplateEpcKey(java.lang.String s)
          Set the default template EPC key for all the Label objects associated with this LabelList.
 void setDefaultTemplateName(java.lang.String s)
          Sets the default template name
 java.lang.String toXmlString(boolean isTop)
          Creates an XML string representation of this AbsstractXMLObject
 
Methods inherited from class com.ibm.rfid.premises.app.entities.AbstractXmlObject
getEndTag, getNodeListFromString, getStartTag, getStringFromElement
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LABEL_LIST

public static final java.lang.String LABEL_LIST
xml tag name used to describe a LabelList

See Also:
toXmlString(boolean), Constant Field Values
Constructor Detail

LabelList

public LabelList()
Basic Constructor


LabelList

public LabelList(java.lang.String xml)
          throws XmlConvertException
Creates a LabelList using the specified XML string

Parameters:
xml -
Throws:
XmlConvertException
Method Detail

setDefaultTemplateEpcKey

public void setDefaultTemplateEpcKey(java.lang.String s)
Set the default template EPC key for all the Label objects associated with this LabelList.

Parameters:
s - default template EPC key

getDefaultTemplateEpcKey

public java.lang.String getDefaultTemplateEpcKey()
Gets the default templace EPC key

Returns:
the default template EPC key

setDefaultTemplateBarcodeKey

public void setDefaultTemplateBarcodeKey(java.lang.String s)
Sets the new default template barcode key

Parameters:
s - new default template barcode key

getDefaultTemplateBarcodeKey

public java.lang.String getDefaultTemplateBarcodeKey()
Gets the default template barcode key

Returns:
the default template barcode key

setDefaultTemplateName

public void setDefaultTemplateName(java.lang.String s)
Sets the default template name

Parameters:
s - default print template that is to be used for the Label objects contained in this LabelList.

getDefaultTemplateName

public java.lang.String getDefaultTemplateName()
Gets the default template name

Returns:
the name of the current default print template

addLabel

public void addLabel(Label label)
Adds a label

Parameters:
label - Label object to be added

getLabel

public Label getLabel(int i)
Gets a specified label

Parameters:
i - index
Returns:
Label found at index i

getLabelListSize

public int getLabelListSize()
Gets the number of labels in the LabelList

Returns:
number of Label objects in the LabelList

addDefaultFormData

public void addDefaultFormData(FormData fd)
Adds default form data to the LabelList

Parameters:
fd - FormData to be used as a default FormData for all Labels

addDefaultFormData

public void addDefaultFormData(java.lang.String name,
                               java.lang.String value)
Adds default form data to the LabelList

Parameters:
name - name of default FormData property to add to this Label List
value - default FormData value

getDefaultFormData

public FormData getDefaultFormData(java.lang.String name)
Returns a FormData with the name specified by the parameter.

Parameters:
name -
Returns:
default FormData for Label objects

getDefaultFormDatas

public java.util.Enumeration getDefaultFormDatas()
Gets the default form datas

Returns:
Enumeration of all default FormData objects for this LabelList

toXmlString

public java.lang.String toXmlString(boolean isTop)
Description copied from class: AbstractXmlObject
Creates an XML string representation of this AbsstractXMLObject

Specified by:
toXmlString in class AbstractXmlObject
Parameters:
isTop - decides whether or not the XML_START field is appended to the output of this method. Should be true if this AbstractXmlObject is the root element.
Returns:
an XML String representing this AbstractXmlObject.
See Also:
AbstractXmlObject.toXmlString(boolean)


Copyright © 2005 - 2009 IBM Corp. All Rights Reserved.