INRIA & FluxMedia

fr.fluxmedia.transmorpher.engine
Class XML_Port

java.lang.Object
  extended by fr.fluxmedia.transmorpher.engine.XML_Port

public final class XML_Port
extends java.lang.Object

Since:
SAX 2.0 && jdk 1.3
Author:
laurent.Tardif@inrialpes.fr

Field Summary
static int CONNECTOR_IN
          Constant for CONNECTOR_IN
static int CONNECTOR_OUT
          Constant for CONNECTOR_OUT
static int CONTENT_DISPATCHER_IN
          Constant for CONTENT_DISPATCHER_IN
static int CONTENT_DISPATCHER_OUT
          Constant for CONTENT_DISPATCHER_OUT
static int CONTENT_HANDLER_IN
          Constant for CONTENT_HANDLER_IN
static int CONTENT_HANDLER_OUT
          Constant for CONTENT_HANDLER_OUT
static int CONTENT_LOG_OUT
           
static int EMPTY
          Constant for NOT AFFECTED PORT
(package private)  javax.xml.transform.sax.TransformerHandler handler
           
(package private)  java.lang.String iCompositeName
          The name of the port in his father, available only for composite element
(package private)  java.lang.Object iContent
          The content flow of the port
(package private)  java.lang.String iDTDName
          the dtd of the port
(package private)  java.lang.String iEncodingType
          The encoding type of the flow
(package private)  int iInOut
          the Type of the port : IN or OUT
static int IN
          constant for IN XML_PORT
(package private)  java.lang.String iName
          The name of the port
static java.lang.String[] InOut
          constant for print IN && OUT XML_PORT
(package private)  int iNumPort
          The port number
(package private)  TProcess iProcessOwner
          The XML TProcess Owner
(package private)  int iTypePort
          The Type of the owner
static int NULL
          Constant for NULL
static int OUT
          constant for OUT XML_PORT
static java.lang.String[] PortType
          Constant for printing PortType
static int SERIALIZER
          Constant for XML SERIALIZER
(package private)  javax.xml.transform.sax.SAXTransformerFactory tfactory
           
static int TRANSFORMER_HANDLER_IN
          Constant for TRANSFORMER_HANDLER_IN
static int TRANSFORMER_HANDLER_OUT
          Constant for TRANSFORMER_HANDLER_OUT
static int XML_READER
          Constant for XML READER
 
Constructor Summary
XML_Port(java.lang.String pName, TApplyExternal pProcessOwner, org.xml.sax.ContentHandler apply, int pNumPort, int pInOut)
           
XML_Port(java.lang.String pName, TProcess pProcessOwner, org.xml.sax.ContentHandler pContentHandler, int pNumPort, int pInOut)
          One constructor for a content handler
XML_Port(java.lang.String pName, TProcess pProcessOwner, int pNumPort, int pInOut)
          One constructor
XML_Port(java.lang.String pName, TProcess pProcessOwner, TDispatcher pTDispatcher, int pNumPort, int pInOut)
          One constructor for TDispatcher ports
XML_Port(java.lang.String pName, TProcess pProcessOwner, TLoop pContentHandler, int pNumPort, int pInOut)
          One constructor for TLoop ports
XML_Port(java.lang.String pName, TProcess pProcessOwner, TMerger pContentHandler, int pNumPort, int pInOut)
          One constructor for TMerger ports
XML_Port(java.lang.String pName, TProcess pProcessOwner, javax.xml.transform.sax.TransformerHandler pTransformerHandler, int pNumPort, int pInOut)
          One constructor for TransformerHandler ports
XML_Port(java.lang.String pName, TProcess pProcessOwner, org.xml.sax.XMLReader pXMLReader, int pNumPort, int pInOut)
          One constructor for XMLReader ports
 
Method Summary
 java.lang.String getCompositeName()
          Get the composite name of the port
 java.lang.Object getContent()
          get the content
 java.lang.String getDTD()
          get the dtd of the port
 java.lang.String getEncoding()
          get the encoding type of the flow
 int getInOut()
          Get the IN/ OUT type of the port
 java.lang.String getName()
          Get the name of the port
 int getNumPort()
          Get the port number
 TProcess getOwner()
          Get the owner of the port
protected  javax.xml.transform.sax.SAXTransformerFactory getTransformerFactory()
           
 int getType()
          Get the owner type
static void link(XML_Port p1, XML_Port p2)
          Link two ports
 void setCompositeName(java.lang.String pCompositeName)
          Set the composite name of the port
 void setContent(java.lang.Object contenthandler)
          Sets the content attribute of the XML_Port object
 void setDTD(java.lang.String pDTDName)
          set the dtd of the port
 void setEncoding(java.lang.String pEncoding)
          Set the encoding type of the flow
 void setName(java.lang.String pName)
          Set the composite name of the port
 java.lang.String toString()
          fonction to pring Port information
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

handler

javax.xml.transform.sax.TransformerHandler handler

tfactory

javax.xml.transform.sax.SAXTransformerFactory tfactory

iName

java.lang.String iName
The name of the port


iCompositeName

java.lang.String iCompositeName
The name of the port in his father, available only for composite element


IN

public static final int IN
constant for IN XML_PORT

See Also:
Constant Field Values

OUT

public static final int OUT
constant for OUT XML_PORT

See Also:
Constant Field Values

InOut

public static final java.lang.String[] InOut
constant for print IN && OUT XML_PORT


XML_READER

public static final int XML_READER
Constant for XML READER

See Also:
Constant Field Values

EMPTY

public static final int EMPTY
Constant for NOT AFFECTED PORT

See Also:
Constant Field Values

SERIALIZER

public static final int SERIALIZER
Constant for XML SERIALIZER

See Also:
Constant Field Values

TRANSFORMER_HANDLER_IN

public static final int TRANSFORMER_HANDLER_IN
Constant for TRANSFORMER_HANDLER_IN

See Also:
Constant Field Values

TRANSFORMER_HANDLER_OUT

public static final int TRANSFORMER_HANDLER_OUT
Constant for TRANSFORMER_HANDLER_OUT

See Also:
Constant Field Values

CONTENT_DISPATCHER_IN

public static final int CONTENT_DISPATCHER_IN
Constant for CONTENT_DISPATCHER_IN

See Also:
Constant Field Values

CONTENT_DISPATCHER_OUT

public static final int CONTENT_DISPATCHER_OUT
Constant for CONTENT_DISPATCHER_OUT

See Also:
Constant Field Values

CONTENT_HANDLER_IN

public static final int CONTENT_HANDLER_IN
Constant for CONTENT_HANDLER_IN

See Also:
Constant Field Values

CONTENT_HANDLER_OUT

public static final int CONTENT_HANDLER_OUT
Constant for CONTENT_HANDLER_OUT

See Also:
Constant Field Values

CONNECTOR_IN

public static final int CONNECTOR_IN
Constant for CONNECTOR_IN

See Also:
Constant Field Values

CONNECTOR_OUT

public static final int CONNECTOR_OUT
Constant for CONNECTOR_OUT

See Also:
Constant Field Values

NULL

public static final int NULL
Constant for NULL

See Also:
Constant Field Values

CONTENT_LOG_OUT

public static final int CONTENT_LOG_OUT
See Also:
Constant Field Values

PortType

public static final java.lang.String[] PortType
Constant for printing PortType


iProcessOwner

TProcess iProcessOwner
The XML TProcess Owner


iNumPort

int iNumPort
The port number


iInOut

int iInOut
the Type of the port : IN or OUT


iTypePort

int iTypePort
The Type of the owner


iEncodingType

java.lang.String iEncodingType
The encoding type of the flow


iDTDName

java.lang.String iDTDName
the dtd of the port


iContent

java.lang.Object iContent
The content flow of the port

Constructor Detail

XML_Port

public XML_Port(java.lang.String pName,
                TProcess pProcessOwner,
                int pNumPort,
                int pInOut)
One constructor

Parameters:
pName - The name of the port.
pProcessOwner - The owner of the port
pNumPort - the number id of the port
pInOut - the type of the port : 0 for IN 1 for OUT

XML_Port

public XML_Port(java.lang.String pName,
                TProcess pProcessOwner,
                org.xml.sax.XMLReader pXMLReader,
                int pNumPort,
                int pInOut)
One constructor for XMLReader ports

Parameters:
pName - The name of the port.
pProcessOwner - The owner of the port
pXMLReader - The XMLReader.
pNumPort - The number id of the port
pInOut - The type of the port : 0 for IN 1 for OUT

XML_Port

public XML_Port(java.lang.String pName,
                TProcess pProcessOwner,
                TDispatcher pTDispatcher,
                int pNumPort,
                int pInOut)
One constructor for TDispatcher ports

Parameters:
pName - The name of the port.
pProcessOwner - The owner of the port
pTDispatcher - The TDispatcher
pNumPort - The number id of the port
pInOut - The type of the port : 0 for IN 1 for OUT

XML_Port

public XML_Port(java.lang.String pName,
                TApplyExternal pProcessOwner,
                org.xml.sax.ContentHandler apply,
                int pNumPort,
                int pInOut)

XML_Port

public XML_Port(java.lang.String pName,
                TProcess pProcessOwner,
                org.xml.sax.ContentHandler pContentHandler,
                int pNumPort,
                int pInOut)
One constructor for a content handler

Parameters:
pName - The name of the port.
pProcessOwner - The owner of the port
pContentHandler - The Content Handler
pNumPort - The number id of the port
pInOut - The type of the port : 0 for IN 1 for OUT

XML_Port

public XML_Port(java.lang.String pName,
                TProcess pProcessOwner,
                TMerger pContentHandler,
                int pNumPort,
                int pInOut)
One constructor for TMerger ports

Parameters:
pName - The name of the port.
pProcessOwner - The owner of the port
pContentHandler - The TMerger
pNumPort - The number id of the port
pInOut - The type of the port : 0 for IN 1 for OUT

XML_Port

public XML_Port(java.lang.String pName,
                TProcess pProcessOwner,
                TLoop pContentHandler,
                int pNumPort,
                int pInOut)
One constructor for TLoop ports

Parameters:
pName - The name of the port.
pProcessOwner - The owner of the port
pContentHandler - The TLoop
pNumPort - The number id of the port
pInOut - The type of the port : 0 for IN 1 for OUT

XML_Port

public XML_Port(java.lang.String pName,
                TProcess pProcessOwner,
                javax.xml.transform.sax.TransformerHandler pTransformerHandler,
                int pNumPort,
                int pInOut)
One constructor for TransformerHandler ports

Parameters:
pName - The name of the port.
pProcessOwner - The owner of the port
pTransformerHandler - The TransmorpherHandler
pNumPort - The number id of the port
pInOut - The type of the port : 0 for IN 1 for OUT
Method Detail

getName

public final java.lang.String getName()
Get the name of the port

Returns:
The name value

getCompositeName

public final java.lang.String getCompositeName()
Get the composite name of the port

Returns:
The compositeName value

setCompositeName

public final void setCompositeName(java.lang.String pCompositeName)
Set the composite name of the port

Parameters:
pCompositeName - The new compositeName value

setName

public final void setName(java.lang.String pName)
Set the composite name of the port

Parameters:
pName - The name of the port. The new name value

getOwner

public final TProcess getOwner()
Get the owner of the port

Returns:
The owner value

getInOut

public final int getInOut()
Get the IN/ OUT type of the port

Returns:
The inOut value

getType

public final int getType()
Get the owner type

Returns:
The type value

getNumPort

public final int getNumPort()
Get the port number

Returns:
The numPort value

getContent

public final java.lang.Object getContent()
get the content

Returns:
The content value

setContent

public final void setContent(java.lang.Object contenthandler)
Sets the content attribute of the XML_Port object

Parameters:
contenthandler - The new content value

setEncoding

public final void setEncoding(java.lang.String pEncoding)
Set the encoding type of the flow

Parameters:
pEncoding - The new encoding value

getEncoding

public final java.lang.String getEncoding()
get the encoding type of the flow

Returns:
The encoding value

setDTD

public final void setDTD(java.lang.String pDTDName)
set the dtd of the port

Parameters:
pDTDName - The new DTD value

getDTD

public final java.lang.String getDTD()
get the dtd of the port

Returns:
The dTD value

link

public static final void link(XML_Port p1,
                              XML_Port p2)
                       throws TMException,
                              org.xml.sax.SAXException
Link two ports

Parameters:
p1 - An XML_Port
p2 - Another XML_Port
Throws:
org.xml.sax.SAXException - Any SAX exception, possibly wrapping another exception.
TMException

toString

public java.lang.String toString()
fonction to pring Port information

Overrides:
toString in class java.lang.Object
Returns:
An string describing this XML_Port

getTransformerFactory

protected javax.xml.transform.sax.SAXTransformerFactory getTransformerFactory()

INRIA & FluxMedia

..no bottom yet...