XSLT (OpenText Process Suite Platform 10.8 Java SDK API)

java.lang.Object
- com.eibus.xml.xpath.XSLT

public final class XSLT
extends java.lang.Object

This class provides transformation methods.
The usage of Nom-Xslt is as follows :

 <code>
       Document oDocument = new Document();
        String xml = 
                                "<books>" + 
                                                 "<book>"+ 
                                                        "<name>abc</name>"+ 
                                                        "<type>computer</type>"+ 
                                                "</book>"+ 
                                                "<book>"+ 
                                                        "<name>xyz</name>"+ 
                                                        "<type>science fiction</type>"+ 
                                                "</book>"+ 
                                        "</books>" ; 
       
       String xsl= 
                        "<xsl:stylesheet version=\"1.0\"  xmlns:xsl=\"http://www.w3.org/1999/XSL/Transform\">"      + 
                                "<xsl:template match=\"books\">"+ 
                                        "<books>"+ 
                                                 "<xsl:apply-templates/>"+ 
                                                "</books>"+ 
                                        "</xsl:template>"+ 
                                        "<xsl:template match=\"name\">"+ 
                                                "<name>"+ 
                                                         "<xsl:apply-templates/>"+ 
                                                "</name>"+ 
                                        "</xsl:template>"+ 
                                        "<xsl:template match=\"book\">"+ 
                                                        "<book>"+ 
                                                                 "<xsl:apply-templates/>"+ 
                                                        "</book>"+ 
                                        "</xsl:template>"+ 
                                                        "<xsl:template match=\"type\">"+ 
                                                                "<genre>"+ 
                                                                         "<xsl:apply-templates/>"+ 
                                                                "</genre>"+ 
                                        "</xsl:template>"+ 
                                "</xsl:stylesheet>"; 
       
       iXml = oDocument.parseString(xml); 
       XSLT oXSL = XSLT.parseFromString(xsl); 
       if(oXSL != null) { 
                  int iTransformedXML = oXSL.xslTransform(iXml); 
                                  System.out.println(Node.writeToString(iTransformedXML, true)); 
                                }        
     The code changes the tag name from "type" to "genre" in the given xml and prints the transformed xml.
 <code>

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`delete()` Deletes the native handle of the `XSLT` object
`protected void`	`finalize()`
`static XSLT`	`parseFromFile(java.lang.String stFileName)`
`static XSLT`	`parseFromString(java.lang.String stXSL)`
`java.lang.String`	`xslStrTransform(int iNomNode, XPathMetaInfo oMetaInfo)` Deprecated. use xslTransformToString()
`int`	`xslTransform(int iNomNode)` It is used for xml to xml conversion.
`int`	`xslTransform(int iNomNode, XPathMetaInfo oMetaInfo)` Deprecated. use xslTransform(int iNomNode) <code> Document oDocument = new Document(); int iXml = oDocument.parseString(xmlStr); //xmlStr has the xml content in String format. XSLT oXSL = XSLT.parseFromString(xslStr); //xslStr has the xsl content in String format. if(oXSL != null) { int iTransformedXML = oXSL.xslTransform(iXml,null); System.out.println(Node.writeToString(iTransformedXML, true)); } </code>
`void`	`xslTransformToFile(java.lang.String stFileName, int iNomNode)` It is used for generic transformation.
`void`	`xslTransformToFile(java.lang.String stFileName, int iNomNode, XPathMetaInfo oMetaInfo)` Deprecated. use xslTransformToFile(String stFileName, int iNomNode). Example: <code> Document oDocument = new Document(); int iXml = oDocument.parseString(xmlStr); //xmlStr has the xml content in String format. XSLT oXSL = XSLT.parseFromString(xslStr); //xslStr has the xsl content in String format. if(oXSL != null) { oXSL.xslTransformToFile("./name.xml",iXml,null); //The transformed result will be in "name.xml". } </code>
`java.lang.String`	`xslTransformToString(int iNomNode)` It is used for generic transformation.
`java.lang.String`	`xslTransformToString(int iNomNode, XPathMetaInfo oMetaInfo)` Deprecated. use xslTransformToString(int iNomNode). Example: <code> Document oDocument = new Document(); int iXml = oDocument.parseString(xmlStr); //xmlStr has the xml content in String format. XSLT oXSL = XSLT.parseFromString(xslStr);//xslStr has the xsl content in String format. if(oXSL != null) { String str = oXSL.xslTransformToString(iXml,null); } </code>

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

parseFromFile
```
public static XSLT parseFromFile(java.lang.String stFileName)
```
Parameters:

stFileName - The xsl filename

Returns:
The XSLT object
Note : It throws XslException if the parser could not parse the file
```
 <code>
  XSLT oXSL = XSLT.parseFromFile(fileName);
 </code>
 
```

parseFromString
```
public static XSLT parseFromString(java.lang.String stXSL)
```
Parameters:

stXSL - The string containing xsl

Returns:
The XSLT object
Note : It throws XslException if the parser could not parse the string
```
 <code>
 XSLT oXSL = XSLT.parseFromString(xsl); <br/>
 </code>
 
```

delete

public void delete()

Deletes the native handle of the XSLT object

 <code>
 XSLT oXSL = XSLT.parseFromString(xsl);
 oXSL.delete();
 </code>

finalize
```
protected void finalize()
                 throws java.lang.Throwable
```
Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

xslTransform

public int xslTransform(int iNomNode)

It is used for xml to xml conversion. The output is a well formed xml.

Parameters:

iNomNode - The NOM node corresponds to the xml to be transformed.

Returns:

The NOM node corresponding to the transformed xml.

 <code>
 Document oDocument = new Document();
 int iXml = oDocument.parseString(xmlStr); //xmlStr has the xml content in String format.
 XSLT oXSL = XSLT.parseFromString(xslStr); //xslStr has the xsl content in String format.
 if(oXSL != null) { 
          int iTransformedXML = oXSL.xslTransform(iXml); 
          System.out.println(Node.writeToString(iTransformedXML, true)); 
                }   
 </code>

xslTransform

public int xslTransform(int iNomNode,
                        XPathMetaInfo oMetaInfo)

Deprecated. use xslTransform(int iNomNode)

 <code>
 Document oDocument = new Document();
 int iXml = oDocument.parseString(xmlStr); //xmlStr has the xml content in String format.
 XSLT oXSL = XSLT.parseFromString(xslStr); //xslStr has the xsl content in String format.
 if(oXSL != null) { 
          int iTransformedXML = oXSL.xslTransform(iXml,null); 
          System.out.println(Node.writeToString(iTransformedXML, true)); 
                }   
 </code>

It is used for xml to xml conversion. The output is a well formed xml.

Parameters:: iNomNode - The NOM node corresponds to the xml to be transformed.; oMetaInfo - The MetaInfoObject
Returns:: The NOM node corresponding to the transformed xml.

xslStrTransform
```
public java.lang.String xslStrTransform(int iNomNode,
                                        XPathMetaInfo oMetaInfo)
```
Deprecated. use xslTransformToString()

It is used for generic transformation. The output may not be xml or well formed xml.

Parameters:

iNomNode - The NOM node

oMetaInfo - The MetaInfoObject

Returns:

The transformed string if it is successful otherwise null

xslTransformToString

public java.lang.String xslTransformToString(int iNomNode)

It is used for generic transformation. The output may not be xml or well formed xml.

Parameters:

iNomNode - The NOM node corresponds to the xml to be transformed.

Returns:

The transformed string if it is successful otherwise null

Example:

 <code>
 Document oDocument = new Document();
 int iXml = oDocument.parseString(xmlStr); //xmlStr has the xml content in String format.
 XSLT oXSL = XSLT.parseFromString(xslStr);//xslStr has the xsl content in String format. 
 if(oXSL != null) { 
          String str = oXSL.xslTransformToString(iXml); 
                }   
 </code>

xslTransformToString

public java.lang.String xslTransformToString(int iNomNode,
                                             XPathMetaInfo oMetaInfo)

Deprecated. use xslTransformToString(int iNomNode).

Example:

 <code>
 Document oDocument = new Document();
 int iXml = oDocument.parseString(xmlStr); //xmlStr has the xml content in String format.
 XSLT oXSL = XSLT.parseFromString(xslStr);//xslStr has the xsl content in String format. 
 if(oXSL != null) { 
          String str = oXSL.xslTransformToString(iXml,null); 
                }   
 </code>

It is used for generic transformation. The output may not be xml or well formed xml.

Parameters:: iNomNode - The NOM node corresponds to the xml to be transformed.; oMetaInfo - The MetaInfoObject
Returns:: The transformed string if it is successful otherwise null

xslTransformToFile

public void xslTransformToFile(java.lang.String stFileName,
                               int iNomNode)

It is used for generic transformation. The output may not be xml or well formed xml.

Parameters:

stFileName - The output file name

iNomNode - The NOM node corresponds to the xml to be transformed.

Example:

 <code>
  Document oDocument = new Document();
 int iXml = oDocument.parseString(xmlStr); //xmlStr has the xml content in String format.
 XSLT oXSL = XSLT.parseFromString(xslStr); //xslStr has the xsl content in String format.
 if(oXSL != null) { 
                oXSL.xslTransformToFile("./name.xml",iXml); //The transformed result will be in "name.xml".
                }   
 </code>

xslTransformToFile

public void xslTransformToFile(java.lang.String stFileName,
                               int iNomNode,
                               XPathMetaInfo oMetaInfo)

Deprecated. use xslTransformToFile(String stFileName, int iNomNode).

Example:

 <code>
  Document oDocument = new Document();
 int iXml = oDocument.parseString(xmlStr); //xmlStr has the xml content in String format.
 XSLT oXSL = XSLT.parseFromString(xslStr); //xslStr has the xsl content in String format.
 if(oXSL != null) { 
                oXSL.xslTransformToFile("./name.xml",iXml,null); //The transformed result will be in "name.xml".
                }   
 </code>

It is used for generic transformation. The output may not be xml or well formed xml.

Parameters:: stFileName - The output file name; iNomNode - The NOM node corresponds to the xml to be transformed.; oMetaInfo - The MetaInfoObject

Class XSLT

Method Summary

Methods inherited from class java.lang.Object

Method Detail

parseFromFile

parseFromString

delete

finalize

xslTransform

xslTransform

xslStrTransform

xslTransformToString

xslTransformToString

xslTransformToFile

xslTransformToFile