org.docx4j.wml.CTMailMerge Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of docx4j-openxml-objects Show documentation
Show all versions of docx4j-openxml-objects Show documentation
Our JAXB representation of OpenXML, except for pml and sml (handled separately)
/*
* Copyright 2007-2013, Plutext Pty Ltd.
*
* This file is part of docx4j.
docx4j is licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package org.docx4j.wml;
import java.math.BigInteger;
import jakarta.xml.bind.Unmarshaller;
import jakarta.xml.bind.annotation.XmlAccessType;
import jakarta.xml.bind.annotation.XmlAccessorType;
import jakarta.xml.bind.annotation.XmlAttribute;
import jakarta.xml.bind.annotation.XmlElement;
import jakarta.xml.bind.annotation.XmlTransient;
import jakarta.xml.bind.annotation.XmlType;
import org.jvnet.jaxb2_commons.ppp.Child;
/**
* Java class for CT_MailMerge complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType name="CT_MailMerge">
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <sequence>
* <element name="mainDocumentType" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}CT_MailMergeDocType"/>
* <element name="linkToQuery" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}BooleanDefaultTrue" minOccurs="0"/>
* <element name="dataType" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}CT_MailMergeDataType"/>
* <element name="connectString" minOccurs="0">
* <complexType>
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <attribute name="val" type="{http://www.w3.org/2001/XMLSchema}string" />
* </restriction>
* </complexContent>
* </complexType>
* </element>
* <element name="query" minOccurs="0">
* <complexType>
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <attribute name="val" type="{http://www.w3.org/2001/XMLSchema}string" />
* </restriction>
* </complexContent>
* </complexType>
* </element>
* <element name="dataSource" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}CT_Rel" minOccurs="0"/>
* <element name="headerSource" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}CT_Rel" minOccurs="0"/>
* <element name="doNotSuppressBlankLines" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}BooleanDefaultTrue" minOccurs="0"/>
* <element name="destination" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}CT_MailMergeDest" minOccurs="0"/>
* <element name="addressFieldName" minOccurs="0">
* <complexType>
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <attribute name="val" type="{http://www.w3.org/2001/XMLSchema}string" />
* </restriction>
* </complexContent>
* </complexType>
* </element>
* <element name="mailSubject" minOccurs="0">
* <complexType>
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <attribute name="val" type="{http://www.w3.org/2001/XMLSchema}string" />
* </restriction>
* </complexContent>
* </complexType>
* </element>
* <element name="mailAsAttachment" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}BooleanDefaultTrue" minOccurs="0"/>
* <element name="viewMergedData" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}BooleanDefaultTrue" minOccurs="0"/>
* <element name="activeRecord" minOccurs="0">
* <complexType>
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <attribute name="val" use="required">
* <simpleType>
* <restriction base="{http://www.w3.org/2001/XMLSchema}integer">
* </restriction>
* </simpleType>
* </attribute>
* </restriction>
* </complexContent>
* </complexType>
* </element>
* <element name="checkErrors" minOccurs="0">
* <complexType>
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <attribute name="val" use="required">
* <simpleType>
* <restriction base="{http://www.w3.org/2001/XMLSchema}integer">
* </restriction>
* </simpleType>
* </attribute>
* </restriction>
* </complexContent>
* </complexType>
* </element>
* <element name="odso" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}CT_Odso" minOccurs="0"/>
* </sequence>
* </restriction>
* </complexContent>
* </complexType>
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "CT_MailMerge", propOrder = {
"mainDocumentType",
"linkToQuery",
"dataType",
"connectString",
"query",
"dataSource",
"headerSource",
"doNotSuppressBlankLines",
"destination",
"addressFieldName",
"mailSubject",
"mailAsAttachment",
"viewMergedData",
"activeRecord",
"checkErrors",
"odso"
})
public class CTMailMerge implements Child
{
@XmlElement(required = true)
protected CTMailMergeDocType mainDocumentType;
protected BooleanDefaultTrue linkToQuery;
@XmlElement(required = true)
protected CTMailMergeDataType dataType;
protected CTMailMerge.ConnectString connectString;
protected CTMailMerge.Query query;
protected CTRel dataSource;
protected CTRel headerSource;
protected BooleanDefaultTrue doNotSuppressBlankLines;
protected CTMailMergeDest destination;
protected CTMailMerge.AddressFieldName addressFieldName;
protected CTMailMerge.MailSubject mailSubject;
protected BooleanDefaultTrue mailAsAttachment;
protected BooleanDefaultTrue viewMergedData;
protected CTMailMerge.ActiveRecord activeRecord;
protected CTMailMerge.CheckErrors checkErrors;
protected CTOdso odso;
@XmlTransient
private Object parent;
/**
* Gets the value of the mainDocumentType property.
*
* @return
* possible object is
* {@link CTMailMergeDocType }
*
*/
public CTMailMergeDocType getMainDocumentType() {
return mainDocumentType;
}
/**
* Sets the value of the mainDocumentType property.
*
* @param value
* allowed object is
* {@link CTMailMergeDocType }
*
*/
public void setMainDocumentType(CTMailMergeDocType value) {
this.mainDocumentType = value;
}
/**
* Gets the value of the linkToQuery property.
*
* @return
* possible object is
* {@link BooleanDefaultTrue }
*
*/
public BooleanDefaultTrue getLinkToQuery() {
return linkToQuery;
}
/**
* Sets the value of the linkToQuery property.
*
* @param value
* allowed object is
* {@link BooleanDefaultTrue }
*
*/
public void setLinkToQuery(BooleanDefaultTrue value) {
this.linkToQuery = value;
}
/**
* Gets the value of the dataType property.
*
* @return
* possible object is
* {@link CTMailMergeDataType }
*
*/
public CTMailMergeDataType getDataType() {
return dataType;
}
/**
* Sets the value of the dataType property.
*
* @param value
* allowed object is
* {@link CTMailMergeDataType }
*
*/
public void setDataType(CTMailMergeDataType value) {
this.dataType = value;
}
/**
* Gets the value of the connectString property.
*
* @return
* possible object is
* {@link CTMailMerge.ConnectString }
*
*/
public CTMailMerge.ConnectString getConnectString() {
return connectString;
}
/**
* Sets the value of the connectString property.
*
* @param value
* allowed object is
* {@link CTMailMerge.ConnectString }
*
*/
public void setConnectString(CTMailMerge.ConnectString value) {
this.connectString = value;
}
/**
* Gets the value of the query property.
*
* @return
* possible object is
* {@link CTMailMerge.Query }
*
*/
public CTMailMerge.Query getQuery() {
return query;
}
/**
* Sets the value of the query property.
*
* @param value
* allowed object is
* {@link CTMailMerge.Query }
*
*/
public void setQuery(CTMailMerge.Query value) {
this.query = value;
}
/**
* Gets the value of the dataSource property.
*
* @return
* possible object is
* {@link CTRel }
*
*/
public CTRel getDataSource() {
return dataSource;
}
/**
* Sets the value of the dataSource property.
*
* @param value
* allowed object is
* {@link CTRel }
*
*/
public void setDataSource(CTRel value) {
this.dataSource = value;
}
/**
* Gets the value of the headerSource property.
*
* @return
* possible object is
* {@link CTRel }
*
*/
public CTRel getHeaderSource() {
return headerSource;
}
/**
* Sets the value of the headerSource property.
*
* @param value
* allowed object is
* {@link CTRel }
*
*/
public void setHeaderSource(CTRel value) {
this.headerSource = value;
}
/**
* Gets the value of the doNotSuppressBlankLines property.
*
* @return
* possible object is
* {@link BooleanDefaultTrue }
*
*/
public BooleanDefaultTrue getDoNotSuppressBlankLines() {
return doNotSuppressBlankLines;
}
/**
* Sets the value of the doNotSuppressBlankLines property.
*
* @param value
* allowed object is
* {@link BooleanDefaultTrue }
*
*/
public void setDoNotSuppressBlankLines(BooleanDefaultTrue value) {
this.doNotSuppressBlankLines = value;
}
/**
* Gets the value of the destination property.
*
* @return
* possible object is
* {@link CTMailMergeDest }
*
*/
public CTMailMergeDest getDestination() {
return destination;
}
/**
* Sets the value of the destination property.
*
* @param value
* allowed object is
* {@link CTMailMergeDest }
*
*/
public void setDestination(CTMailMergeDest value) {
this.destination = value;
}
/**
* Gets the value of the addressFieldName property.
*
* @return
* possible object is
* {@link CTMailMerge.AddressFieldName }
*
*/
public CTMailMerge.AddressFieldName getAddressFieldName() {
return addressFieldName;
}
/**
* Sets the value of the addressFieldName property.
*
* @param value
* allowed object is
* {@link CTMailMerge.AddressFieldName }
*
*/
public void setAddressFieldName(CTMailMerge.AddressFieldName value) {
this.addressFieldName = value;
}
/**
* Gets the value of the mailSubject property.
*
* @return
* possible object is
* {@link CTMailMerge.MailSubject }
*
*/
public CTMailMerge.MailSubject getMailSubject() {
return mailSubject;
}
/**
* Sets the value of the mailSubject property.
*
* @param value
* allowed object is
* {@link CTMailMerge.MailSubject }
*
*/
public void setMailSubject(CTMailMerge.MailSubject value) {
this.mailSubject = value;
}
/**
* Gets the value of the mailAsAttachment property.
*
* @return
* possible object is
* {@link BooleanDefaultTrue }
*
*/
public BooleanDefaultTrue getMailAsAttachment() {
return mailAsAttachment;
}
/**
* Sets the value of the mailAsAttachment property.
*
* @param value
* allowed object is
* {@link BooleanDefaultTrue }
*
*/
public void setMailAsAttachment(BooleanDefaultTrue value) {
this.mailAsAttachment = value;
}
/**
* Gets the value of the viewMergedData property.
*
* @return
* possible object is
* {@link BooleanDefaultTrue }
*
*/
public BooleanDefaultTrue getViewMergedData() {
return viewMergedData;
}
/**
* Sets the value of the viewMergedData property.
*
* @param value
* allowed object is
* {@link BooleanDefaultTrue }
*
*/
public void setViewMergedData(BooleanDefaultTrue value) {
this.viewMergedData = value;
}
/**
* Gets the value of the activeRecord property.
*
* @return
* possible object is
* {@link CTMailMerge.ActiveRecord }
*
*/
public CTMailMerge.ActiveRecord getActiveRecord() {
return activeRecord;
}
/**
* Sets the value of the activeRecord property.
*
* @param value
* allowed object is
* {@link CTMailMerge.ActiveRecord }
*
*/
public void setActiveRecord(CTMailMerge.ActiveRecord value) {
this.activeRecord = value;
}
/**
* Gets the value of the checkErrors property.
*
* @return
* possible object is
* {@link CTMailMerge.CheckErrors }
*
*/
public CTMailMerge.CheckErrors getCheckErrors() {
return checkErrors;
}
/**
* Sets the value of the checkErrors property.
*
* @param value
* allowed object is
* {@link CTMailMerge.CheckErrors }
*
*/
public void setCheckErrors(CTMailMerge.CheckErrors value) {
this.checkErrors = value;
}
/**
* Gets the value of the odso property.
*
* @return
* possible object is
* {@link CTOdso }
*
*/
public CTOdso getOdso() {
return odso;
}
/**
* Sets the value of the odso property.
*
* @param value
* allowed object is
* {@link CTOdso }
*
*/
public void setOdso(CTOdso value) {
this.odso = value;
}
/**
* Gets the parent object in the object tree representing the unmarshalled xml document.
*
* @return
* The parent object.
*/
public Object getParent() {
return this.parent;
}
public void setParent(Object parent) {
this.parent = parent;
}
/**
* This method is invoked by the JAXB implementation on each instance when unmarshalling completes.
*
* @param parent
* The parent object in the object tree.
* @param unmarshaller
* The unmarshaller that generated the instance.
*/
public void afterUnmarshal(Unmarshaller unmarshaller, Object parent) {
setParent(parent);
}
/**
* Java class for anonymous complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType>
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <attribute name="val" use="required">
* <simpleType>
* <restriction base="{http://www.w3.org/2001/XMLSchema}integer">
* </restriction>
* </simpleType>
* </attribute>
* </restriction>
* </complexContent>
* </complexType>
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "")
public static class ActiveRecord implements Child
{
@XmlAttribute(name = "val", namespace = "http://schemas.openxmlformats.org/wordprocessingml/2006/main", required = true)
protected BigInteger val;
@XmlTransient
private Object parent;
/**
* Gets the value of the val property.
*
* @return
* possible object is
* {@link BigInteger }
*
*/
public BigInteger getVal() {
return val;
}
/**
* Sets the value of the val property.
*
* @param value
* allowed object is
* {@link BigInteger }
*
*/
public void setVal(BigInteger value) {
this.val = value;
}
/**
* Gets the parent object in the object tree representing the unmarshalled xml document.
*
* @return
* The parent object.
*/
public Object getParent() {
return this.parent;
}
public void setParent(Object parent) {
this.parent = parent;
}
/**
* This method is invoked by the JAXB implementation on each instance when unmarshalling completes.
*
* @param parent
* The parent object in the object tree.
* @param unmarshaller
* The unmarshaller that generated the instance.
*/
public void afterUnmarshal(Unmarshaller unmarshaller, Object parent) {
setParent(parent);
}
}
/**
* Java class for anonymous complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType>
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <attribute name="val" type="{http://www.w3.org/2001/XMLSchema}string" />
* </restriction>
* </complexContent>
* </complexType>
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "")
public static class AddressFieldName implements Child
{
@XmlAttribute(name = "val", namespace = "http://schemas.openxmlformats.org/wordprocessingml/2006/main")
protected String val;
@XmlTransient
private Object parent;
/**
* Gets the value of the val property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getVal() {
return val;
}
/**
* Sets the value of the val property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setVal(String value) {
this.val = value;
}
/**
* Gets the parent object in the object tree representing the unmarshalled xml document.
*
* @return
* The parent object.
*/
public Object getParent() {
return this.parent;
}
public void setParent(Object parent) {
this.parent = parent;
}
/**
* This method is invoked by the JAXB implementation on each instance when unmarshalling completes.
*
* @param parent
* The parent object in the object tree.
* @param unmarshaller
* The unmarshaller that generated the instance.
*/
public void afterUnmarshal(Unmarshaller unmarshaller, Object parent) {
setParent(parent);
}
}
/**
* Java class for anonymous complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType>
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <attribute name="val" use="required">
* <simpleType>
* <restriction base="{http://www.w3.org/2001/XMLSchema}integer">
* </restriction>
* </simpleType>
* </attribute>
* </restriction>
* </complexContent>
* </complexType>
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "")
public static class CheckErrors implements Child
{
@XmlAttribute(name = "val", namespace = "http://schemas.openxmlformats.org/wordprocessingml/2006/main", required = true)
protected BigInteger val;
@XmlTransient
private Object parent;
/**
* Gets the value of the val property.
*
* @return
* possible object is
* {@link BigInteger }
*
*/
public BigInteger getVal() {
return val;
}
/**
* Sets the value of the val property.
*
* @param value
* allowed object is
* {@link BigInteger }
*
*/
public void setVal(BigInteger value) {
this.val = value;
}
/**
* Gets the parent object in the object tree representing the unmarshalled xml document.
*
* @return
* The parent object.
*/
public Object getParent() {
return this.parent;
}
public void setParent(Object parent) {
this.parent = parent;
}
/**
* This method is invoked by the JAXB implementation on each instance when unmarshalling completes.
*
* @param parent
* The parent object in the object tree.
* @param unmarshaller
* The unmarshaller that generated the instance.
*/
public void afterUnmarshal(Unmarshaller unmarshaller, Object parent) {
setParent(parent);
}
}
/**
* Java class for anonymous complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType>
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <attribute name="val" type="{http://www.w3.org/2001/XMLSchema}string" />
* </restriction>
* </complexContent>
* </complexType>
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "")
public static class ConnectString implements Child
{
@XmlAttribute(name = "val", namespace = "http://schemas.openxmlformats.org/wordprocessingml/2006/main")
protected String val;
@XmlTransient
private Object parent;
/**
* Gets the value of the val property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getVal() {
return val;
}
/**
* Sets the value of the val property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setVal(String value) {
this.val = value;
}
/**
* Gets the parent object in the object tree representing the unmarshalled xml document.
*
* @return
* The parent object.
*/
public Object getParent() {
return this.parent;
}
public void setParent(Object parent) {
this.parent = parent;
}
/**
* This method is invoked by the JAXB implementation on each instance when unmarshalling completes.
*
* @param parent
* The parent object in the object tree.
* @param unmarshaller
* The unmarshaller that generated the instance.
*/
public void afterUnmarshal(Unmarshaller unmarshaller, Object parent) {
setParent(parent);
}
}
/**
* Java class for anonymous complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType>
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <attribute name="val" type="{http://www.w3.org/2001/XMLSchema}string" />
* </restriction>
* </complexContent>
* </complexType>
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "")
public static class MailSubject implements Child
{
@XmlAttribute(name = "val", namespace = "http://schemas.openxmlformats.org/wordprocessingml/2006/main")
protected String val;
@XmlTransient
private Object parent;
/**
* Gets the value of the val property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getVal() {
return val;
}
/**
* Sets the value of the val property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setVal(String value) {
this.val = value;
}
/**
* Gets the parent object in the object tree representing the unmarshalled xml document.
*
* @return
* The parent object.
*/
public Object getParent() {
return this.parent;
}
public void setParent(Object parent) {
this.parent = parent;
}
/**
* This method is invoked by the JAXB implementation on each instance when unmarshalling completes.
*
* @param parent
* The parent object in the object tree.
* @param unmarshaller
* The unmarshaller that generated the instance.
*/
public void afterUnmarshal(Unmarshaller unmarshaller, Object parent) {
setParent(parent);
}
}
/**
* Java class for anonymous complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType>
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <attribute name="val" type="{http://www.w3.org/2001/XMLSchema}string" />
* </restriction>
* </complexContent>
* </complexType>
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "")
public static class Query implements Child
{
@XmlAttribute(name = "val", namespace = "http://schemas.openxmlformats.org/wordprocessingml/2006/main")
protected String val;
@XmlTransient
private Object parent;
/**
* Gets the value of the val property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getVal() {
return val;
}
/**
* Sets the value of the val property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setVal(String value) {
this.val = value;
}
/**
* Gets the parent object in the object tree representing the unmarshalled xml document.
*
* @return
* The parent object.
*/
public Object getParent() {
return this.parent;
}
public void setParent(Object parent) {
this.parent = parent;
}
/**
* This method is invoked by the JAXB implementation on each instance when unmarshalling completes.
*
* @param parent
* The parent object in the object tree.
* @param unmarshaller
* The unmarshaller that generated the instance.
*/
public void afterUnmarshal(Unmarshaller unmarshaller, Object parent) {
setParent(parent);
}
}
}