com.mgz.afp.modca

Class LLE_LinkLogicalElement

java.lang.Object

com.mgz.afp.base.StructuredField

com.mgz.afp.modca.LLE_LinkLogicalElement

All Implemented Interfaces:

IAFPDecodeableWriteable

public class LLE_LinkLogicalElement
extends StructuredField

LLE_LinkLogicalElement (MO:DCA, page 222)
A Link Logical Element structured field specifies the linkage from a source document component to a target document component. The LLE identifies the source and target and indicates the purpose of the linkage by specifying a link type. The link source and link target may be in the same document component or in different document components, and they need not be of the same document component type. The linkage may involve a complete document component, or it may be restricted to a rectangular area on the presentation space associated with the document component. The Link Logical Element structured field can be embedded in the document that contains the link source, in the document that contains the link target, in the document index for either document, or in any combination of these structures. Link Logical Element parameters do not provide any presentation specifications.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LLE_LinkLogicalElement.LLE_LinkType Specifies the purpose of the link.
static class	LLE_LinkLogicalElement.LLE_RepeatingGroup

Constructor Summary

Constructors

Constructor and Description
LLE_LinkLogicalElement()

Method Summary

Modifier and Type	Method and Description
void	addRepeatingGroup(LLE_LinkLogicalElement.LLE_RepeatingGroup repeatingGroup)
void	decodeAFP(byte[] sfData, int offset, int length, AFPParserConfiguration config) Decodes the given AFP data. Parameter length specifies the length in bytes of the data to be decoded, beginning with position offset.
LLE_LinkLogicalElement.LLE_LinkType	getLinkType()
java.util.List<LLE_LinkLogicalElement.LLE_RepeatingGroup>	getRepeatingGroups()
byte	getReserved1()
void	removeRepeatingGroup(LLE_LinkLogicalElement.LLE_RepeatingGroup repeatingGroup)
void	setLinkType(LLE_LinkLogicalElement.LLE_LinkType linkType)
void	setRepeatingGroups(java.util.List<LLE_LinkLogicalElement.LLE_RepeatingGroup> repeatingGroups)
void	setReserved1(byte reserved1)
void	writeAFP(java.io.OutputStream os, AFPParserConfiguration config) Writes the object to the given os encoded as AFP data.

Methods inherited from class com.mgz.afp.base.StructuredField

checkDataLength, getActualLength, getPadding, getStructuredFieldIntroducer, isBeginSF, isEndSF, isShallow, setPadding, setStructuredFieldIntroducer, toString, writeFullStructuredField

Methods inherited from class java.lang.Object

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

Constructor Detail

LLE_LinkLogicalElement

public LLE_LinkLogicalElement()

Method Detail

decodeAFP

public void decodeAFP(byte[] sfData,
                      int offset,
                      int length,
                      AFPParserConfiguration config)
               throws AFPParserException

Description copied from interface: IAFPDecodeableWriteable

Decodes the given AFP data.
Parameter length specifies the length in bytes of the data to be decoded, beginning with position offset. If parameter length has a value of -1, the given data array is decoded up to the end of the array.

Specified by:

decodeAFP in interface IAFPDecodeableWriteable

Specified by:

decodeAFP in class StructuredField

Parameters:

sfData - contains the AFP data to decode.

offset - the byte index position where the decoding should start.

length - the length in bytes of the data to be decoded, beginning with position offset.

config - contains parameter used for decoding.

Throws:

AFPParserException - if the given AFP data are invalid.

writeAFP

public void writeAFP(java.io.OutputStream os,
                     AFPParserConfiguration config)
              throws java.io.IOException

Description copied from interface: IAFPDecodeableWriteable

Writes the object to the given os encoded as AFP data.

Specified by:

writeAFP in interface IAFPDecodeableWriteable

Specified by:

writeAFP in class StructuredField

Parameters:

os - OutputStream to write to.

config - contains parameter used for encoding.

Throws:

java.io.IOException - if a problem occurs while writing to the given OutputStream.

getLinkType

public LLE_LinkLogicalElement.LLE_LinkType getLinkType()

setLinkType

public void setLinkType(LLE_LinkLogicalElement.LLE_LinkType linkType)

getReserved1

public byte getReserved1()

setReserved1

public void setReserved1(byte reserved1)

getRepeatingGroups

public java.util.List<LLE_LinkLogicalElement.LLE_RepeatingGroup> getRepeatingGroups()

setRepeatingGroups

public void setRepeatingGroups(java.util.List<LLE_LinkLogicalElement.LLE_RepeatingGroup> repeatingGroups)

addRepeatingGroup

public void addRepeatingGroup(LLE_LinkLogicalElement.LLE_RepeatingGroup repeatingGroup)

removeRepeatingGroup

public void removeRepeatingGroup(LLE_LinkLogicalElement.LLE_RepeatingGroup repeatingGroup)