AppianTypeFactory (appian-typetransformer 1.3 API)

java.lang.Object
- com.appiancorp.ps.plugins.typetransformer.AppianTypeFactory

public class AppianTypeFactory
extends Object

This class is the primary entry point for working with this library. The first step is to create a newInstance(com.appiancorp.suiteapi.type.TypeService) of this class, then it can be used to read and create TypedValues, build CDTs from scratch, etc.

Reading a data subset

 TypeService ts = ...
 TypedValue tv = ...
 AppianTypeFactory tf = AppianTypeFactory.newInstance(ts);
 AppianObject datasubset = (AppianObject) tf.toAppianElement(tv);
 
 long startIndex = datasubset.getPrimitive("startIndex").getLong();
 long batchSize = datasubset.getPrimitive("batchSize").getLong();
 
 AppianList data = datasubset.getList("data");
 
 for (AppianObject row : data.toArray(new AppianObject[] {})) {
   long id = row.getPrimitive("id").getLong();
   String name = row.getPrimitive("name").getString();
 }

Converting to a TypedValue

 TypeService ts = ...
 AppianElement element = ...
 AppianTypeFactory tf = AppianTypeFactory.newInstance(ts);
 TypedValue tv = tf.toTypedValue(element);

Creating a list from scratch

 AppianList values = tf.createList(AppianType.STRING);
 
 values.add(tf.createString("Hello"));
 values.add(tf.createString("World!"));

Create a CDT from scratch

 Datatype type = ts.getTypeByQualifiedName(new QName("urn:appian:acme", "project"));
 AppianObject project = (AppianObject) tf.createElement(type.getId());
 
 project.put("name", tf.createString("My First Project"));
 project.put("isComplete", tf.createBoolean(true));

Creating a dictionary

 AppianObject dictionary = (AppianObject) tf.createElement(AppianType.DICTIONARY);
 
 dictionary.put("name", tf.createString("My First Project"));
 dictionary.put("isComplete", tf.createBoolean(true));

Converting a TypedValue object to Java Object

 TypedValue tv = ...
 Customer customer = (AppianObject) tf.toJavaObject(tv, Customer.class);
 
 String name = customer.getName();
 Date date = customer.getJoinedDate();

Author:: james.carter

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AppianPrimitive`	`createBoolean(Boolean value)` Creates a boolean with the given value
`AppianPrimitive`	`createDate(Date value)` Creates a date with the given value
`AppianPrimitive`	`createDateTime(Timestamp value)` Creates a date and time with the given value
`AppianPrimitive`	`createDouble(Double value)` Creates a double with the given value
`AppianElement`	`createElement(long typeId)` Creates a new element of the given type.
`AppianList`	`createList(long typeId)` Creates a list of the given type.
`AppianPrimitive`	`createLong(Long value)` Creates a long with the given value
`AppianPrimitive`	`createString(String value)` Creates a string with the given value
`AppianPrimitive`	`createTime(Time value)` Creates a time with the given value
`static AppianTypeFactory`	`newInstance(com.appiancorp.suiteapi.type.TypeService ts)`
`AppianElement`	`toAppianElement(com.appiancorp.suiteapi.process.ProcessVariableInstance pvi)` Converts the given ProcessVariableInstance into an element
`AppianElement`	`toAppianElement(com.appiancorp.suiteapi.type.TypedValue tv)` Converts the given TypedValue into an element
`<T> T`	`toJavaObject(AppianObject object, Class<T> clazz)` Creates a new instance of a concrete Java object from an AppianObject.
`<T> T`	`toJavaObject(com.appiancorp.suiteapi.type.TypedValue tv, Class<T> clazz)` Creates a new instance of a concrete Java object from a TypedValue
`com.appiancorp.suiteapi.type.TypedValue`	`toTypedValue(AppianElement element)` Converts the given element into a TypedValue
`void`	`walkElementTree(AppianElement element, AppianElementVisitor visitor)` Walks an element tree at the given starting element.

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

- Method Detail
  - toAppianElement
```
public AppianElement toAppianElement(com.appiancorp.suiteapi.type.TypedValue tv)
```
    Converts the given TypedValue into an element
    
    Parameters:
    
    tv - the TypedValue to be converted to an AppianElement
    
    Returns:
    
    Returns an element for the given TypedValue
  - toAppianElement
```
public AppianElement toAppianElement(com.appiancorp.suiteapi.process.ProcessVariableInstance pvi)
```
    Converts the given ProcessVariableInstance into an element
    
    Parameters:
    
    pvi - the ProcessVariableInstance to be converted to an AppianElement
    
    Returns:
    
    Returns an element for the given ProcessVariableInstance
  - toTypedValue
```
public com.appiancorp.suiteapi.type.TypedValue toTypedValue(AppianElement element)
```
    Converts the given element into a TypedValue
    
    Parameters:
    
    element - the element to be converted to a TypedValue
    
    Returns:
    
    Returns a TypedValue for the given element.
  - toJavaObject
```
public <T> T toJavaObject(com.appiancorp.suiteapi.type.TypedValue tv,
                          Class<T> clazz)
                   throws JAXBException
```
    Creates a new instance of a concrete Java object from a TypedValue
    
    Parameters:
    
    tv - The TypedValue to be converted to an AppianElement
    
    clazz - The JAXB annotated Java class representing the TypedValue structure
    
    Returns:
    
    the newly created Java object
    
    Throws:
    
    JAXBException
    
    ClassCastException - if the TypedValue is not an AppianObject
  - toJavaObject
```
public <T> T toJavaObject(AppianObject object,
                          Class<T> clazz)
                   throws JAXBException
```
    Creates a new instance of a concrete Java object from an AppianObject. The class must be annotated with XmlRootElement
    
    Parameters:
    
    object - The complex Appian type to create a Java object for
    
    clazz - The JAXB annotated Java class representing the TypedValue structure
    
    Returns:
    
    the newly created Java object
    
    Throws:
    
    JAXBException
  - walkElementTree
```
public void walkElementTree(AppianElement element,
                            AppianElementVisitor visitor)
                     throws Exception
```
    Walks an element tree at the given starting element. The tree traversal is depth-first with the given visitor invoked for each element encountered. Traversal completes when all accessible elements in the tree have been visited, or a visit method returns a result of AppianElementVisitResult.TERMINATE. Where a visit method terminates due an Exception the traversal is terminated and the error or exception is propagated to the caller of this method.
    
    Parameters:
    
    element - the starting element to traverse
    
    visitor - the element visitor to invoke with each element found
    
    Throws:
    
    Exception - if an exception is thrown by a visitor method
  - createElement
```
public AppianElement createElement(long typeId)
```
    Creates a new element of the given type.
    
    Parameters:
    
    typeId - the Appian type id to create an element of
    
    Returns:
    
    an instance of AppianList, AppianObject or AppianPrimitive
    
    See Also:
    
    AppianList, AppianObject, AppianPrimitive
  - createList
```
public AppianList createList(long typeId)
```
    Creates a list of the given type.
    
    Parameters:
    
    typeId - the type to create a list of
    
    Returns:
    
    a list of the given type.
  - createBoolean
```
public AppianPrimitive createBoolean(Boolean value)
```
    Creates a boolean with the given value
    
    Parameters:
    
    value - the initial value
    
    Returns:
    
    a new boolean wrapped in an AppianPrimitive
  - createDate
```
public AppianPrimitive createDate(Date value)
```
    Creates a date with the given value
    
    Parameters:
    
    value - the initial value
    
    Returns:
    
    a new date wrapped in an AppianPrimitive
  - createDateTime
```
public AppianPrimitive createDateTime(Timestamp value)
```
    Creates a date and time with the given value
    
    Parameters:
    
    value - the initial value
    
    Returns:
    
    a new date and time wrapped in an AppianPrimitive
  - createDouble
```
public AppianPrimitive createDouble(Double value)
```
    Creates a double with the given value
    
    Parameters:
    
    value - the initial value
    
    Returns:
    
    a new double wrapped in an AppianPrimitive
  - createLong
```
public AppianPrimitive createLong(Long value)
```
    Creates a long with the given value
    
    Parameters:
    
    value - the initial value
    
    Returns:
    
    a new long wrapped in an AppianPrimitive
  - createString
```
public AppianPrimitive createString(String value)
```
    Creates a string with the given value
    
    Parameters:
    
    value - the initial value
    
    Returns:
    
    a new string wrapped in an AppianPrimitive
  - createTime
```
public AppianPrimitive createTime(Time value)
```
    Creates a time with the given value
    
    Parameters:
    
    value - the initial value
    
    Returns:
    
    a new time wrapped in an AppianPrimitive
  - newInstance
```
public static final AppianTypeFactory newInstance(com.appiancorp.suiteapi.type.TypeService ts)
```

Class AppianTypeFactory

Method Summary

Methods inherited from class java.lang.Object

Method Detail

toAppianElement

toAppianElement

toTypedValue

toJavaObject

toJavaObject

walkElementTree

createElement

createList

createBoolean

createDate

createDateTime

createDouble

createLong

createString

createTime

newInstance