Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright (c) 2016-2017 by OpenText Corporation. All Rights Reserved.
*/
package com.opentext.ia.sip.assembly.stringtemplate;
import java.io.IOException;
import java.io.InputStream;
import java.io.PrintWriter;
import java.util.Date;
import java.util.Map;
import javax.annotation.Nullable;
import org.stringtemplate.v4.*;
import com.opentext.ia.sdk.sip.ContentInfo;
import com.opentext.ia.sdk.sip.DigitalObject;
import com.opentext.ia.sdk.sip.FixedHeaderAndFooterTemplate;
import com.opentext.ia.sdk.sip.Template;
/**
* {@linkplain Template} using the StringTemplate template engine.
* Templates have access to the following objects:
*
*
model
*
The domain object (of type D)
*
content
*
The reference information and the encoded hashes of the {@linkplain DigitalObject}s associated with the domain object, if any
*
* @param The type of domain object to replace with text
*/
public class StringTemplate extends FixedHeaderAndFooterTemplate {
private static final char DEFAULT_DELIMETER_START_CHAR = '$';
private static final char DEFAULT_DELIMETER_END_CHAR = '$';
private static final String TEMPLATE_NAME = "template";
private static final String MODEL_VARIABLE = "model";
private static final String CONTENT_VARIABLE = "content";
private final ST templatePrototype;
/**
* Create an instance.
* @param header The fixed header
* @param footer The fixed footer
* @param row The template for the rows
*/
public StringTemplate(InputStream header, InputStream footer, InputStream row) {
this(toString(header), toString(footer), toString(row));
}
/**
* Create an instance with the default start and end delimeters.
* @param header The fixed header
* @param footer The fixed footer
* @param row The template for the rows
*/
public StringTemplate(String header, String footer, String row) {
this(header, footer, row, DEFAULT_DELIMETER_START_CHAR, DEFAULT_DELIMETER_END_CHAR);
}
/**
* Create an instance.
* @param header The fixed header
* @param footer The fixed footer
* @param row The template for the rows
* @param delimeterStart The character that starts a StringTemplate expression.
* @param delimeterEnd The character that ends a StringTemplate expression.
*/
public StringTemplate(String header, String footer, String row, char delimeterStart, char delimeterEnd) {
super(header, footer);
this.templatePrototype = compileTemplate(row, delimeterStart, delimeterEnd);
}
@Nullable
private ST compileTemplate(String row, char delimeterStartChar, char delimeterEndChar) {
STGroup group = new STGroup(delimeterStartChar, delimeterEndChar);
prepareGroup(group);
group.defineTemplate(TEMPLATE_NAME, MODEL_VARIABLE + ',' + CONTENT_VARIABLE, row);
return group.getInstanceOf(TEMPLATE_NAME);
}
/**
* Prepares a group by adding renderers, adaptors and sub templates. Override this if you want to add additional
* renderers. By default adds:
*
*
an {@linkplain XmlDateRenderer} which renders Date instances into the standard XML date and time format
*
an {@linkplain MapModelAdaptor} which allows {@linkplain java.util.Map} to be used transparently as domain
* objects.
*
* @param group The template group
*/
protected void prepareGroup(STGroup group) {
registerAdaptor(group, Map.class, new MapModelAdaptor());
registerRenderer(group, Date.class, new XmlDateRenderer());
}
/**
* Registers a ModelAdaptor with the group. Override this method if you want to suppress one OOTB adaptor but not all.
* @param The domain object type
* @param group The template group
* @param type The domain object class
* @param adaptor The adaptor that will be used to extract properties of objects of type S
*/
protected void registerAdaptor(STGroup group, Class type, ModelAdaptor adaptor) {
group.registerModelAdaptor(type, adaptor);
}
/**
* Registers a renderer with the group. Override this method if you want to suppress one OOTB renderer but not all.
* @param The domain object type
* @param group The template group
* @param type The domain object class
* @param attributeRenderer The renderer that will be used to render objects of type S into a String
*/
protected void registerRenderer(STGroup group, Class type, AttributeRenderer attributeRenderer) {
group.registerRenderer(type, attributeRenderer);
}
@Override
public void writeRow(D domainObject, Map contentInfo, PrintWriter writer) throws IOException {
ST template = prepareTemplate(templatePrototype, domainObject, contentInfo);
template.write(new NoIndentWriter(writer));
}
/**
* Prepares the template by adding the variables.
* @param prototype The template prototype
* @param domainObject The domain object
* @param contentInfo The reference information and the encoded content hashes
* @return The prepared template instance
*/
protected ST prepareTemplate(ST prototype, D domainObject, Map contentInfo) {
ST template = new ST(prototype);
template.add(MODEL_VARIABLE, domainObject);
template.add(CONTENT_VARIABLE, contentInfo);
return template;
}
}
