CTCacheField (docx4j-openxml-objects-sml 8.1.2 API)

java.lang.Object
- org.xlsx4j.sml.CTCacheField

All Implemented Interfaces:: Child

public class CTCacheField
extends Object
implements Child

Java class for CT_CacheField complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="CT_CacheField">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="sharedItems" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}CT_SharedItems" minOccurs="0"/>
         <element name="fieldGroup" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}CT_FieldGroup" minOccurs="0"/>
         <element name="mpMap" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}CT_X" maxOccurs="unbounded" minOccurs="0"/>
         <element name="extLst" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}CT_ExtensionList" minOccurs="0"/>
       </sequence>
       <attribute name="name" use="required" type="{http://schemas.openxmlformats.org/officeDocument/2006/sharedTypes}ST_Xstring" />
       <attribute name="caption" type="{http://schemas.openxmlformats.org/officeDocument/2006/sharedTypes}ST_Xstring" />
       <attribute name="propertyName" type="{http://schemas.openxmlformats.org/officeDocument/2006/sharedTypes}ST_Xstring" />
       <attribute name="serverField" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="uniqueList" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="numFmtId" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}ST_NumFmtId" />
       <attribute name="formula" type="{http://schemas.openxmlformats.org/officeDocument/2006/sharedTypes}ST_Xstring" />
       <attribute name="sqlType" type="{http://www.w3.org/2001/XMLSchema}int" default="0" />
       <attribute name="hierarchy" type="{http://www.w3.org/2001/XMLSchema}int" default="0" />
       <attribute name="level" type="{http://www.w3.org/2001/XMLSchema}unsignedInt" default="0" />
       <attribute name="databaseField" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="mappingCount" type="{http://www.w3.org/2001/XMLSchema}unsignedInt" />
       <attribute name="memberPropertyField" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`caption`
`protected Boolean`	`databaseField`
`protected CTExtensionList`	`extLst`
`protected CTFieldGroup`	`fieldGroup`
`protected String`	`formula`
`protected Integer`	`hierarchy`
`protected Long`	`level`
`protected Long`	`mappingCount`
`protected Boolean`	`memberPropertyField`
`protected List<CTX>`	`mpMap`
`protected String`	`name`
`protected Long`	`numFmtId`
`protected String`	`propertyName`
`protected Boolean`	`serverField`
`protected CTSharedItems`	`sharedItems`
`protected Integer`	`sqlType`
`protected Boolean`	`uniqueList`

Constructor Summary

Constructors
Constructor and Description

CTCacheField()

Constructors
Constructor and Description
`CTCacheField()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterUnmarshal(Unmarshaller unmarshaller, Object parent)` This method is invoked by the JAXB implementation on each instance when unmarshalling completes.
`String`	`getCaption()` Gets the value of the caption property.
`CTExtensionList`	`getExtLst()` Gets the value of the extLst property.
`CTFieldGroup`	`getFieldGroup()` Gets the value of the fieldGroup property.
`String`	`getFormula()` Gets the value of the formula property.
`int`	`getHierarchy()` Gets the value of the hierarchy property.
`long`	`getLevel()` Gets the value of the level property.
`Long`	`getMappingCount()` Gets the value of the mappingCount property.
`List<CTX>`	`getMpMap()` Gets the value of the mpMap property.
`String`	`getName()` Gets the value of the name property.
`Long`	`getNumFmtId()` Gets the value of the numFmtId property.
`Object`	`getParent()` Gets the parent object in the object tree representing the unmarshalled xml document.
`String`	`getPropertyName()` Gets the value of the propertyName property.
`CTSharedItems`	`getSharedItems()` Gets the value of the sharedItems property.
`int`	`getSqlType()` Gets the value of the sqlType property.
`boolean`	`isDatabaseField()` Gets the value of the databaseField property.
`boolean`	`isMemberPropertyField()` Gets the value of the memberPropertyField property.
`boolean`	`isServerField()` Gets the value of the serverField property.
`boolean`	`isUniqueList()` Gets the value of the uniqueList property.
`void`	`setCaption(String value)` Sets the value of the caption property.
`void`	`setDatabaseField(Boolean value)` Sets the value of the databaseField property.
`void`	`setExtLst(CTExtensionList value)` Sets the value of the extLst property.
`void`	`setFieldGroup(CTFieldGroup value)` Sets the value of the fieldGroup property.
`void`	`setFormula(String value)` Sets the value of the formula property.
`void`	`setHierarchy(Integer value)` Sets the value of the hierarchy property.
`void`	`setLevel(Long value)` Sets the value of the level property.
`void`	`setMappingCount(Long value)` Sets the value of the mappingCount property.
`void`	`setMemberPropertyField(Boolean value)` Sets the value of the memberPropertyField property.
`void`	`setName(String value)` Sets the value of the name property.
`void`	`setNumFmtId(Long value)` Sets the value of the numFmtId property.
`void`	`setParent(Object parent)`
`void`	`setPropertyName(String value)` Sets the value of the propertyName property.
`void`	`setServerField(Boolean value)` Sets the value of the serverField property.
`void`	`setSharedItems(CTSharedItems value)` Sets the value of the sharedItems property.
`void`	`setSqlType(Integer value)` Sets the value of the sqlType property.
`void`	`setUniqueList(Boolean value)` Sets the value of the uniqueList property.

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

- Field Detail
  - sharedItems
```
protected CTSharedItems sharedItems
```
  - fieldGroup
```
protected CTFieldGroup fieldGroup
```
  - mpMap
```
protected List<CTX> mpMap
```
  - extLst
```
protected CTExtensionList extLst
```
  - name
```
protected String name
```
  - caption
```
protected String caption
```
  - propertyName
```
protected String propertyName
```
  - serverField
```
protected Boolean serverField
```
  - uniqueList
```
protected Boolean uniqueList
```
  - numFmtId
```
protected Long numFmtId
```
  - formula
```
protected String formula
```
  - sqlType
```
protected Integer sqlType
```
  - hierarchy
```
protected Integer hierarchy
```
  - level
```
protected Long level
```
  - databaseField
```
protected Boolean databaseField
```
  - mappingCount
```
protected Long mappingCount
```
  - memberPropertyField
```
protected Boolean memberPropertyField
```
- Constructor Detail
  - CTCacheField
```
public CTCacheField()
```
- Method Detail
  - getSharedItems
```
public CTSharedItems getSharedItems()
```
    Gets the value of the sharedItems property.
    
    Returns:
    
    possible object is CTSharedItems
  - setSharedItems
```
public void setSharedItems(CTSharedItems value)
```
    Sets the value of the sharedItems property.
    
    Parameters:
    
    value - allowed object is CTSharedItems
  - getFieldGroup
```
public CTFieldGroup getFieldGroup()
```
    Gets the value of the fieldGroup property.
    
    Returns:
    
    possible object is CTFieldGroup
  - setFieldGroup
```
public void setFieldGroup(CTFieldGroup value)
```
    Sets the value of the fieldGroup property.
    
    Parameters:
    
    value - allowed object is CTFieldGroup
  - getMpMap
```
public List<CTX> getMpMap()
```
    Gets the value of the mpMap property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the mpMap property.
    For example, to add a new item, do as follows:
```
    getMpMap().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list CTX
  - getExtLst
```
public CTExtensionList getExtLst()
```
    Gets the value of the extLst property.
    
    Returns:
    
    possible object is CTExtensionList
  - setExtLst
```
public void setExtLst(CTExtensionList value)
```
    Sets the value of the extLst property.
    
    Parameters:
    
    value - allowed object is CTExtensionList
  - getName
```
public String getName()
```
    Gets the value of the name property.
    
    Returns:
    
    possible object is String
  - setName
```
public void setName(String value)
```
    Sets the value of the name property.
    
    Parameters:
    
    value - allowed object is String
  - getCaption
```
public String getCaption()
```
    Gets the value of the caption property.
    
    Returns:
    
    possible object is String
  - setCaption
```
public void setCaption(String value)
```
    Sets the value of the caption property.
    
    Parameters:
    
    value - allowed object is String
  - getPropertyName
```
public String getPropertyName()
```
    Gets the value of the propertyName property.
    
    Returns:
    
    possible object is String
  - setPropertyName
```
public void setPropertyName(String value)
```
    Sets the value of the propertyName property.
    
    Parameters:
    
    value - allowed object is String
  - isServerField
```
public boolean isServerField()
```
    Gets the value of the serverField property.
    
    Returns:
    
    possible object is Boolean
  - setServerField
```
public void setServerField(Boolean value)
```
    Sets the value of the serverField property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isUniqueList
```
public boolean isUniqueList()
```
    Gets the value of the uniqueList property.
    
    Returns:
    
    possible object is Boolean
  - setUniqueList
```
public void setUniqueList(Boolean value)
```
    Sets the value of the uniqueList property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getNumFmtId
```
public Long getNumFmtId()
```
    Gets the value of the numFmtId property.
    
    Returns:
    
    possible object is Long
  - setNumFmtId
```
public void setNumFmtId(Long value)
```
    Sets the value of the numFmtId property.
    
    Parameters:
    
    value - allowed object is Long
  - getFormula
```
public String getFormula()
```
    Gets the value of the formula property.
    
    Returns:
    
    possible object is String
  - setFormula
```
public void setFormula(String value)
```
    Sets the value of the formula property.
    
    Parameters:
    
    value - allowed object is String
  - getSqlType
```
public int getSqlType()
```
    Gets the value of the sqlType property.
    
    Returns:
    
    possible object is Integer
  - setSqlType
```
public void setSqlType(Integer value)
```
    Sets the value of the sqlType property.
    
    Parameters:
    
    value - allowed object is Integer
  - getHierarchy
```
public int getHierarchy()
```
    Gets the value of the hierarchy property.
    
    Returns:
    
    possible object is Integer
  - setHierarchy
```
public void setHierarchy(Integer value)
```
    Sets the value of the hierarchy property.
    
    Parameters:
    
    value - allowed object is Integer
  - getLevel
```
public long getLevel()
```
    Gets the value of the level property.
    
    Returns:
    
    possible object is Long
  - setLevel
```
public void setLevel(Long value)
```
    Sets the value of the level property.
    
    Parameters:
    
    value - allowed object is Long
  - isDatabaseField
```
public boolean isDatabaseField()
```
    Gets the value of the databaseField property.
    
    Returns:
    
    possible object is Boolean
  - setDatabaseField
```
public void setDatabaseField(Boolean value)
```
    Sets the value of the databaseField property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getMappingCount
```
public Long getMappingCount()
```
    Gets the value of the mappingCount property.
    
    Returns:
    
    possible object is Long
  - setMappingCount
```
public void setMappingCount(Long value)
```
    Sets the value of the mappingCount property.
    
    Parameters:
    
    value - allowed object is Long
  - isMemberPropertyField
```
public boolean isMemberPropertyField()
```
    Gets the value of the memberPropertyField property.
    
    Returns:
    
    possible object is Boolean
  - setMemberPropertyField
```
public void setMemberPropertyField(Boolean value)
```
    Sets the value of the memberPropertyField property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getParent
```
public Object getParent()
```
    Gets the parent object in the object tree representing the unmarshalled xml document.
    
    Specified by:
    
    getParent in interface Child
    
    Returns:
    
    The parent object.
  - setParent
```
public void setParent(Object parent)
```
    Specified by:
    
    setParent in interface Child
  - afterUnmarshal
```
public void afterUnmarshal(Unmarshaller unmarshaller,
                           Object parent)
```
    This method is invoked by the JAXB implementation on each instance when unmarshalling completes.
    
    Parameters:
    
    parent - The parent object in the object tree.
    
    unmarshaller - The unmarshaller that generated the instance.

Class CTCacheField

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

sharedItems

fieldGroup

mpMap

extLst

name

caption

propertyName

serverField

uniqueList

numFmtId

formula

sqlType

hierarchy

level

databaseField

mappingCount

memberPropertyField

Constructor Detail

CTCacheField

Method Detail

getSharedItems

setSharedItems

getFieldGroup

setFieldGroup

getMpMap

getExtLst

setExtLst

getName

setName

getCaption

setCaption

getPropertyName

setPropertyName

isServerField

setServerField

isUniqueList

setUniqueList

getNumFmtId

setNumFmtId

getFormula

setFormula

getSqlType

setSqlType

getHierarchy

setHierarchy

getLevel

setLevel

isDatabaseField

setDatabaseField

getMappingCount

setMappingCount

isMemberPropertyField

setMemberPropertyField

getParent

setParent

afterUnmarshal