|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.rfid.premises.app.entities.AbstractXmlObject
com.ibm.rfid.premises.app.entities.supplychain.printing.Label
public class Label
This class represents an actual label/tag being printed/written to during a print job. The details of the tag bring written to are defined in an EpcData object stored within the class. Any optional details regarding label layout or text printed on the actual label are defined in FormData objects stored within the class.
Within a print job submission, Label objects are stored in a
LabelList
object. There must be atleast one
Label per LabelList.
LabelList
,
EpcData
,
FormData
Field Summary | |
---|---|
static java.lang.String |
LABEL
xml tag name used to describe a Label |
Fields inherited from class com.ibm.rfid.premises.app.entities.AbstractXmlObject |
---|
attributes_, EQ, GT, LT, QUOTE, SLASH, tagName_, XML_START |
Constructor Summary | |
---|---|
Label()
Basic Constructor |
|
Label(java.lang.String xml)
Creates a Label object using specified XML content |
Method Summary | |
---|---|
void |
addFormData(FormData fd)
Add a FormData |
void |
addFormData(java.lang.String name,
java.lang.String value)
Add a FormData custom property to this Label |
void |
addProperties(java.util.Properties p)
Add a set of properties as FormData objects in this label |
java.lang.String |
getCompanyPrefix()
Gets the company prefix |
EpcData |
getEpcData()
Gets the EPC data |
java.lang.String |
getEpcEncoding()
Gets the EPC encoding |
FormData |
getFormData(java.lang.String name)
Gets a FormData object based on specified FormData name |
java.util.Enumeration |
getFormDatas()
Return all the FormData objects associated with this Label object. |
java.lang.String |
getQuantity()
Gets the quantity of labels that are to be printed |
java.lang.String |
getTemplateBarcodeKey()
Gets the template barcode key |
java.lang.String |
getTemplateEpcKey()
Gets the template EPC key |
java.lang.String |
getTemplateName()
Gets the template name |
java.lang.String |
getUnitType()
Gets the unit type |
void |
setEpcData(EpcData ed)
Sets the EpcData object for this Label to the parameter. |
void |
setQuantity(int i)
Set the number of labels you want printed |
void |
setTemplateBarcodeKey(java.lang.String s)
Sets the new template barcode key |
void |
setTemplateEpcKey(java.lang.String s)
Sets the new template EPC key |
void |
setTemplateName(java.lang.String s)
Sets the template name |
void |
setUnitType(java.lang.String s)
Sets the new unit type |
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 |
---|
public static final java.lang.String LABEL
toXmlString(boolean)
,
Constant Field ValuesConstructor Detail |
---|
public Label()
public Label(java.lang.String xml) throws XmlConvertException
xml
-
XmlConvertException
Method Detail |
---|
public void setQuantity(int i)
i
- number of labels to printpublic void addProperties(java.util.Properties p)
p
- Properties to add to this labeladdFormData(FormData)
public java.lang.String getQuantity()
public void setTemplateBarcodeKey(java.lang.String s)
s
- new template barcode keypublic java.lang.String getTemplateBarcodeKey()
public void setTemplateEpcKey(java.lang.String s)
s
- new template EPC keypublic java.lang.String getTemplateEpcKey()
public void setTemplateName(java.lang.String s)
s
- the print template that is to be
used for this Label objectpublic java.lang.String getTemplateName()
public void setUnitType(java.lang.String s)
s
- the new unit type for this Labelpublic java.lang.String getUnitType()
public void addFormData(java.lang.String name, java.lang.String value)
name
- name of FormData to be addedvalue
- value of FormData to be addedpublic void addFormData(FormData fd)
fd
- FormData to be added to Labelpublic FormData getFormData(java.lang.String name)
name
- name of FormData to search for
public java.util.Enumeration getFormDatas()
public java.lang.String getCompanyPrefix()
public java.lang.String getEpcEncoding()
public EpcData getEpcData()
public void setEpcData(EpcData ed)
ed
- the new EpcData objectpublic java.lang.String toXmlString(boolean isTop)
AbstractXmlObject
toXmlString
in class AbstractXmlObject
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.
AbstractXmlObject.toXmlString(boolean)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |