MetadataFieldType (Generated 4.17.5 API)

java.lang.Object
- com.vidispine.generated.MetadataFieldType

All Implemented Interfaces:: Serializable, Cloneable, org.jvnet.jaxb2_commons.lang.CopyTo, org.jvnet.jaxb2_commons.lang.Equals

public class MetadataFieldType
extends Object
implements Serializable, Cloneable, org.jvnet.jaxb2_commons.lang.CopyTo, org.jvnet.jaxb2_commons.lang.Equals

Java class for MetadataFieldType complex type.

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

 <complexType name="MetadataFieldType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="name" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="schema" type="{http://xml.vidispine.com/schema/vidispine}MetadataSchemaElementType" minOccurs="0"/>
         <element name="type" type="{http://xml.vidispine.com/schema/vidispine}MetadataFieldTypeType" minOccurs="0"/>
         <element name="index" type="{http://xml.vidispine.com/schema/vidispine}MetadataFieldIndexType" minOccurs="0"/>
         <element name="fullText" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="constraint" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <sequence>
                   <element name="dataset" type="{http://www.w3.org/2001/XMLSchema}string"/>
                   <element name="levelProperty" type="{http://www.w3.org/2001/XMLSchema}string"/>
                   <element name="levelValue" type="{http://www.w3.org/2001/XMLSchema}string"/>
                   <element name="value" type="{http://www.w3.org/2001/XMLSchema}string"/>
                   <choice>
                     <element name="validationGroup" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
                     <element name="parent" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
                   </choice>
                 </sequence>
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <choice minOccurs="0">
           <element name="floatRestriction" type="{http://xml.vidispine.com/schema/vidispine}MetadataFieldFloatType"/>
           <element name="integerRestriction" type="{http://xml.vidispine.com/schema/vidispine}MetadataFieldIntegerType"/>
           <element name="longRestriction" type="{http://xml.vidispine.com/schema/vidispine}MetadataFieldLongType"/>
           <element name="stringRestriction" type="{http://xml.vidispine.com/schema/vidispine}MetadataFieldStringType"/>
         </choice>
         <element name="data" type="{http://xml.vidispine.com/schema/vidispine}KeyValuePairType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="values" type="{http://xml.vidispine.com/schema/vidispine}SimpleMetadataType" minOccurs="0"/>
         <element name="defaultValue" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="externalId" type="{http://www.w3.org/2001/XMLSchema}string" maxOccurs="unbounded" minOccurs="0"/>
         <element name="origin" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="boost" type="{http://www.w3.org/2001/XMLSchema}float" minOccurs="0"/>
       </sequence>
       <attribute name="system" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="sortable" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="inheritance" type="{http://www.w3.org/2001/XMLSchema}string" />
     </restriction>
   </complexContent>
 </complexType>

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MetadataFieldType.Constraint
Java class for anonymous complex type.

static class MetadataFieldType.PropInfo

Nested Classes
Modifier and Type	Class and Description
`static class`	`MetadataFieldType.Constraint` Java class for anonymous complex type.
`static class`	`MetadataFieldType.PropInfo`

Field Summary

Fields
Modifier and Type	Field and Description
`protected Float`	`boost`
`protected MetadataFieldType.Constraint`	`constraint`
`protected List<KeyValuePairType>`	`data`
`protected String`	`defaultValue`
`protected List<String>`	`externalId`
`protected MetadataFieldFloatType`	`floatRestriction`
`protected Boolean`	`fullText`
`protected MetadataFieldIndexType`	`index`
`protected String`	`inheritance`
`protected MetadataFieldIntegerType`	`integerRestriction`
`protected MetadataFieldLongType`	`longRestriction`
`protected String`	`name`
`protected String`	`origin`
`protected MetadataSchemaElementType`	`schema`
`protected Boolean`	`sortable`
`protected MetadataFieldStringType`	`stringRestriction`
`protected String`	`system`
`protected MetadataFieldTypeType`	`type`
`protected SimpleMetadataType`	`values`

Constructor Summary

Constructors
Constructor and Description

MetadataFieldType()

Constructors
Constructor and Description
`MetadataFieldType()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`clone()`
`Object`	`copyTo(Object target)`
`Object`	`copyTo(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, Object target, org.jvnet.jaxb2_commons.lang.CopyStrategy strategy)`
`Object`	`createNewInstance()`
`boolean`	`equals(Object object)`
`boolean`	`equals(org.jvnet.jaxb2_commons.locator.ObjectLocator thisLocator, org.jvnet.jaxb2_commons.locator.ObjectLocator thatLocator, Object object, org.jvnet.jaxb2_commons.lang.EqualsStrategy strategy)`
`Float`	`getBoost()` Gets the value of the boost property.
`MetadataFieldType.Constraint`	`getConstraint()` Gets the value of the constraint property.
`List<KeyValuePairType>`	`getData()` Gets the value of the data property.
`String`	`getDefaultValue()` Gets the value of the defaultValue property.
`List<String>`	`getExternalId()` Gets the value of the externalId property.
`MetadataFieldFloatType`	`getFloatRestriction()` Gets the value of the floatRestriction property.
`MetadataFieldIndexType`	`getIndex()` Gets the value of the index property.
`String`	`getInheritance()` Gets the value of the inheritance property.
`MetadataFieldIntegerType`	`getIntegerRestriction()` Gets the value of the integerRestriction property.
`MetadataFieldLongType`	`getLongRestriction()` Gets the value of the longRestriction property.
`String`	`getName()` Gets the value of the name property.
`String`	`getOrigin()` Gets the value of the origin property.
`MetadataSchemaElementType`	`getSchema()` Gets the value of the schema property.
`MetadataFieldStringType`	`getStringRestriction()` Gets the value of the stringRestriction property.
`String`	`getSystem()` Gets the value of the system property.
`MetadataFieldTypeType`	`getType()` Gets the value of the type property.
`SimpleMetadataType`	`getValues()` Gets the value of the values property.
`Boolean`	`isFullText()` Gets the value of the fullText property.
`boolean`	`isSetBoost()`
`boolean`	`isSetConstraint()`
`boolean`	`isSetData()`
`boolean`	`isSetDefaultValue()`
`boolean`	`isSetExternalId()`
`boolean`	`isSetFloatRestriction()`
`boolean`	`isSetFullText()`
`boolean`	`isSetIndex()`
`boolean`	`isSetInheritance()`
`boolean`	`isSetIntegerRestriction()`
`boolean`	`isSetLongRestriction()`
`boolean`	`isSetName()`
`boolean`	`isSetOrigin()`
`boolean`	`isSetSchema()`
`boolean`	`isSetSortable()`
`boolean`	`isSetStringRestriction()`
`boolean`	`isSetSystem()`
`boolean`	`isSetType()`
`boolean`	`isSetValues()`
`boolean`	`isSortable()` Gets the value of the sortable property.
`void`	`setBoost(Float value)` Sets the value of the boost property.
`void`	`setConstraint(MetadataFieldType.Constraint value)` Sets the value of the constraint property.
`void`	`setDefaultValue(String value)` Sets the value of the defaultValue property.
`void`	`setFloatRestriction(MetadataFieldFloatType value)` Sets the value of the floatRestriction property.
`void`	`setFullText(Boolean value)` Sets the value of the fullText property.
`void`	`setIndex(MetadataFieldIndexType value)` Sets the value of the index property.
`void`	`setInheritance(String value)` Sets the value of the inheritance property.
`void`	`setIntegerRestriction(MetadataFieldIntegerType value)` Sets the value of the integerRestriction property.
`void`	`setLongRestriction(MetadataFieldLongType value)` Sets the value of the longRestriction property.
`void`	`setName(String value)` Sets the value of the name property.
`void`	`setOrigin(String value)` Sets the value of the origin property.
`void`	`setSchema(MetadataSchemaElementType value)` Sets the value of the schema property.
`void`	`setSortable(boolean value)` Sets the value of the sortable property.
`void`	`setStringRestriction(MetadataFieldStringType value)` Sets the value of the stringRestriction property.
`void`	`setSystem(String value)` Sets the value of the system property.
`void`	`setType(MetadataFieldTypeType value)` Sets the value of the type property.
`void`	`setValues(SimpleMetadataType value)` Sets the value of the values property.
`void`	`unsetData()`
`void`	`unsetExternalId()`
`void`	`unsetSortable()`
`MetadataFieldType`	`visit(com.kscs.util.jaxb.PropertyVisitor _visitor_)`
`MetadataFieldType`	`withBoost(Float value)`
`MetadataFieldType`	`withConstraint(MetadataFieldType.Constraint value)`
`MetadataFieldType`	`withData(Collection<KeyValuePairType> values)`
`MetadataFieldType`	`withData(KeyValuePairType... values)`
`MetadataFieldType`	`withDefaultValue(String value)`
`MetadataFieldType`	`withExternalId(Collection<String> values)`
`MetadataFieldType`	`withExternalId(String... values)`
`MetadataFieldType`	`withFloatRestriction(MetadataFieldFloatType value)`
`MetadataFieldType`	`withFullText(Boolean value)`
`MetadataFieldType`	`withIndex(MetadataFieldIndexType value)`
`MetadataFieldType`	`withInheritance(String value)`
`MetadataFieldType`	`withIntegerRestriction(MetadataFieldIntegerType value)`
`MetadataFieldType`	`withLongRestriction(MetadataFieldLongType value)`
`MetadataFieldType`	`withName(String value)`
`MetadataFieldType`	`withOrigin(String value)`
`MetadataFieldType`	`withSchema(MetadataSchemaElementType value)`
`MetadataFieldType`	`withSortable(boolean value)`
`MetadataFieldType`	`withStringRestriction(MetadataFieldStringType value)`
`MetadataFieldType`	`withSystem(String value)`
`MetadataFieldType`	`withType(MetadataFieldTypeType value)`
`MetadataFieldType`	`withValues(SimpleMetadataType value)`

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

Field Detail

name
```
protected String name
```

schema

protected MetadataSchemaElementType schema

type
```
protected MetadataFieldTypeType type
```

index
```
protected MetadataFieldIndexType index
```

fullText
```
protected Boolean fullText
```

constraint

protected MetadataFieldType.Constraint constraint

floatRestriction

protected MetadataFieldFloatType floatRestriction

integerRestriction

protected MetadataFieldIntegerType integerRestriction

longRestriction

protected MetadataFieldLongType longRestriction

stringRestriction

protected MetadataFieldStringType stringRestriction

data
```
protected List<KeyValuePairType> data
```

values
```
protected SimpleMetadataType values
```

defaultValue
```
protected String defaultValue
```

externalId
```
protected List<String> externalId
```

origin
```
protected String origin
```

boost
```
protected Float boost
```

system
```
protected String system
```

sortable
```
protected Boolean sortable
```

inheritance
```
protected String inheritance
```

Constructor Detail
- MetadataFieldType
```
public MetadataFieldType()
```

Method Detail
- 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
- isSetName
```
public boolean isSetName()
```
- getSchema
```
public MetadataSchemaElementType getSchema()
```
  Gets the value of the schema property.
  
  Returns:
  
  possible object is MetadataSchemaElementType
- setSchema
```
public void setSchema(MetadataSchemaElementType value)
```
  Sets the value of the schema property.
  
  Parameters:
  
  value - allowed object is MetadataSchemaElementType
- isSetSchema
```
public boolean isSetSchema()
```
- getType
```
public MetadataFieldTypeType getType()
```
  Gets the value of the type property.
  
  Returns:
  
  possible object is MetadataFieldTypeType
- setType
```
public void setType(MetadataFieldTypeType value)
```
  Sets the value of the type property.
  
  Parameters:
  
  value - allowed object is MetadataFieldTypeType
- isSetType
```
public boolean isSetType()
```
- getIndex
```
public MetadataFieldIndexType getIndex()
```
  Gets the value of the index property.
  
  Returns:
  
  possible object is MetadataFieldIndexType
- setIndex
```
public void setIndex(MetadataFieldIndexType value)
```
  Sets the value of the index property.
  
  Parameters:
  
  value - allowed object is MetadataFieldIndexType
- isSetIndex
```
public boolean isSetIndex()
```
- isFullText
```
public Boolean isFullText()
```
  Gets the value of the fullText property.
  
  Returns:
  
  possible object is Boolean
- setFullText
```
public void setFullText(Boolean value)
```
  Sets the value of the fullText property.
  
  Parameters:
  
  value - allowed object is Boolean
- isSetFullText
```
public boolean isSetFullText()
```
- getConstraint
```
public MetadataFieldType.Constraint getConstraint()
```
  Gets the value of the constraint property.
  
  Returns:
  
  possible object is MetadataFieldType.Constraint
- setConstraint
```
public void setConstraint(MetadataFieldType.Constraint value)
```
  Sets the value of the constraint property.
  
  Parameters:
  
  value - allowed object is MetadataFieldType.Constraint
- isSetConstraint
```
public boolean isSetConstraint()
```
- getFloatRestriction
```
public MetadataFieldFloatType getFloatRestriction()
```
  Gets the value of the floatRestriction property.
  
  Returns:
  
  possible object is MetadataFieldFloatType
- setFloatRestriction
```
public void setFloatRestriction(MetadataFieldFloatType value)
```
  Sets the value of the floatRestriction property.
  
  Parameters:
  
  value - allowed object is MetadataFieldFloatType
- isSetFloatRestriction
```
public boolean isSetFloatRestriction()
```
- getIntegerRestriction
```
public MetadataFieldIntegerType getIntegerRestriction()
```
  Gets the value of the integerRestriction property.
  
  Returns:
  
  possible object is MetadataFieldIntegerType
- setIntegerRestriction
```
public void setIntegerRestriction(MetadataFieldIntegerType value)
```
  Sets the value of the integerRestriction property.
  
  Parameters:
  
  value - allowed object is MetadataFieldIntegerType
- isSetIntegerRestriction
```
public boolean isSetIntegerRestriction()
```
- getLongRestriction
```
public MetadataFieldLongType getLongRestriction()
```
  Gets the value of the longRestriction property.
  
  Returns:
  
  possible object is MetadataFieldLongType
- setLongRestriction
```
public void setLongRestriction(MetadataFieldLongType value)
```
  Sets the value of the longRestriction property.
  
  Parameters:
  
  value - allowed object is MetadataFieldLongType
- isSetLongRestriction
```
public boolean isSetLongRestriction()
```
- getStringRestriction
```
public MetadataFieldStringType getStringRestriction()
```
  Gets the value of the stringRestriction property.
  
  Returns:
  
  possible object is MetadataFieldStringType
- setStringRestriction
```
public void setStringRestriction(MetadataFieldStringType value)
```
  Sets the value of the stringRestriction property.
  
  Parameters:
  
  value - allowed object is MetadataFieldStringType
- isSetStringRestriction
```
public boolean isSetStringRestriction()
```
- getData
```
public List<KeyValuePairType> getData()
```
  Gets the value of the data 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 data property.
  For example, to add a new item, do as follows:
```
    getData().add(newItem);
 
```
  Objects of the following type(s) are allowed in the list KeyValuePairType
- isSetData
```
public boolean isSetData()
```
- unsetData
```
public void unsetData()
```
- getValues
```
public SimpleMetadataType getValues()
```
  Gets the value of the values property.
  
  Returns:
  
  possible object is SimpleMetadataType
- setValues
```
public void setValues(SimpleMetadataType value)
```
  Sets the value of the values property.
  
  Parameters:
  
  value - allowed object is SimpleMetadataType
- isSetValues
```
public boolean isSetValues()
```
- getDefaultValue
```
public String getDefaultValue()
```
  Gets the value of the defaultValue property.
  
  Returns:
  
  possible object is String
- setDefaultValue
```
public void setDefaultValue(String value)
```
  Sets the value of the defaultValue property.
  
  Parameters:
  
  value - allowed object is String
- isSetDefaultValue
```
public boolean isSetDefaultValue()
```
- getExternalId
```
public List<String> getExternalId()
```
  Gets the value of the externalId 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 externalId property.
  For example, to add a new item, do as follows:
```
    getExternalId().add(newItem);
 
```
  Objects of the following type(s) are allowed in the list String
- isSetExternalId
```
public boolean isSetExternalId()
```
- unsetExternalId
```
public void unsetExternalId()
```
- getOrigin
```
public String getOrigin()
```
  Gets the value of the origin property.
  
  Returns:
  
  possible object is String
- setOrigin
```
public void setOrigin(String value)
```
  Sets the value of the origin property.
  
  Parameters:
  
  value - allowed object is String
- isSetOrigin
```
public boolean isSetOrigin()
```
- getBoost
```
public Float getBoost()
```
  Gets the value of the boost property.
  
  Returns:
  
  possible object is Float
- setBoost
```
public void setBoost(Float value)
```
  Sets the value of the boost property.
  
  Parameters:
  
  value - allowed object is Float
- isSetBoost
```
public boolean isSetBoost()
```
- getSystem
```
public String getSystem()
```
  Gets the value of the system property.
  
  Returns:
  
  possible object is String
- setSystem
```
public void setSystem(String value)
```
  Sets the value of the system property.
  
  Parameters:
  
  value - allowed object is String
- isSetSystem
```
public boolean isSetSystem()
```
- isSortable
```
public boolean isSortable()
```
  Gets the value of the sortable property.
  
  Returns:
  
  possible object is Boolean
- setSortable
```
public void setSortable(boolean value)
```
  Sets the value of the sortable property.
  
  Parameters:
  
  value - allowed object is Boolean
- isSetSortable
```
public boolean isSetSortable()
```
- unsetSortable
```
public void unsetSortable()
```
- getInheritance
```
public String getInheritance()
```
  Gets the value of the inheritance property.
  
  Returns:
  
  possible object is String
- setInheritance
```
public void setInheritance(String value)
```
  Sets the value of the inheritance property.
  
  Parameters:
  
  value - allowed object is String
- isSetInheritance
```
public boolean isSetInheritance()
```
- clone
```
public Object clone()
```
  Overrides:
  
  clone in class Object
- copyTo
```
public Object copyTo(Object target)
```
  Specified by:
  
  copyTo in interface org.jvnet.jaxb2_commons.lang.CopyTo
- copyTo
```
public Object copyTo(org.jvnet.jaxb2_commons.locator.ObjectLocator locator,
                     Object target,
                     org.jvnet.jaxb2_commons.lang.CopyStrategy strategy)
```
  Specified by:
  
  copyTo in interface org.jvnet.jaxb2_commons.lang.CopyTo
- createNewInstance
```
public Object createNewInstance()
```
  Specified by:
  
  createNewInstance in interface org.jvnet.jaxb2_commons.lang.CopyTo
- withName
```
public MetadataFieldType withName(String value)
```
- withSchema
```
public MetadataFieldType withSchema(MetadataSchemaElementType value)
```
- withType
```
public MetadataFieldType withType(MetadataFieldTypeType value)
```
- withIndex
```
public MetadataFieldType withIndex(MetadataFieldIndexType value)
```
- withFullText
```
public MetadataFieldType withFullText(Boolean value)
```
- withConstraint
```
public MetadataFieldType withConstraint(MetadataFieldType.Constraint value)
```
- withFloatRestriction
```
public MetadataFieldType withFloatRestriction(MetadataFieldFloatType value)
```
- withIntegerRestriction
```
public MetadataFieldType withIntegerRestriction(MetadataFieldIntegerType value)
```
- withLongRestriction
```
public MetadataFieldType withLongRestriction(MetadataFieldLongType value)
```
- withStringRestriction
```
public MetadataFieldType withStringRestriction(MetadataFieldStringType value)
```
- withData
```
public MetadataFieldType withData(KeyValuePairType... values)
```
- withData
```
public MetadataFieldType withData(Collection<KeyValuePairType> values)
```
- withValues
```
public MetadataFieldType withValues(SimpleMetadataType value)
```
- withDefaultValue
```
public MetadataFieldType withDefaultValue(String value)
```
- withExternalId
```
public MetadataFieldType withExternalId(String... values)
```
- withExternalId
```
public MetadataFieldType withExternalId(Collection<String> values)
```
- withOrigin
```
public MetadataFieldType withOrigin(String value)
```
- withBoost
```
public MetadataFieldType withBoost(Float value)
```
- withSystem
```
public MetadataFieldType withSystem(String value)
```
- withSortable
```
public MetadataFieldType withSortable(boolean value)
```
- withInheritance
```
public MetadataFieldType withInheritance(String value)
```
- equals
```
public boolean equals(org.jvnet.jaxb2_commons.locator.ObjectLocator thisLocator,
                      org.jvnet.jaxb2_commons.locator.ObjectLocator thatLocator,
                      Object object,
                      org.jvnet.jaxb2_commons.lang.EqualsStrategy strategy)
```
  Specified by:
  
  equals in interface org.jvnet.jaxb2_commons.lang.Equals
- equals
```
public boolean equals(Object object)
```
  Overrides:
  
  equals in class Object
- visit
```
public MetadataFieldType visit(com.kscs.util.jaxb.PropertyVisitor _visitor_)
```

Class MetadataFieldType

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

schema

type

index

fullText

constraint

floatRestriction

integerRestriction

longRestriction

stringRestriction

data

values

defaultValue

externalId

origin

boost

system

sortable

inheritance

Constructor Detail

MetadataFieldType

Method Detail

getName

setName

isSetName

getSchema

setSchema

isSetSchema

getType

setType

isSetType

getIndex

setIndex

isSetIndex

isFullText

setFullText

isSetFullText

getConstraint

setConstraint

isSetConstraint

getFloatRestriction

setFloatRestriction

isSetFloatRestriction

getIntegerRestriction

setIntegerRestriction

isSetIntegerRestriction

getLongRestriction

setLongRestriction

isSetLongRestriction

getStringRestriction

setStringRestriction

isSetStringRestriction

getData

isSetData

unsetData

getValues

setValues

isSetValues

getDefaultValue

setDefaultValue

isSetDefaultValue

getExternalId

isSetExternalId

unsetExternalId

getOrigin

setOrigin

isSetOrigin

getBoost

setBoost

isSetBoost

getSystem

setSystem

isSetSystem