public class CSMetaDataContent extends CSItemContent
CSMetaData
object.
CSMetaData
,
Serialized FormConstructor and Description |
---|
CSMetaDataContent()
Creates an empty
CSMetaDataContent object. |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj)
Determines whether the data contained in this
CSMetaDataContent object is the same as that
contained within the one supplied. |
java.lang.String |
getDescription()
Gets the metadata description.
|
java.lang.String |
getExternalSchemaID()
Gets the external schema ID.
|
java.lang.String |
getExternalSchemaName()
Gets the external schema name.
|
int |
getGroupID()
Gets the ID that identifies the group that this metadata value is associated with.
|
java.lang.String |
getGroupName()
Gets the metadata group name.
|
java.lang.String |
getGroupSearchField()
Gets the metadata group search field.
|
java.lang.String |
getKnownTerms()
Gets the known terms (synonyms).
|
java.lang.String |
getLocalTerms()
Gets the local terms (synonyms).
|
java.lang.String |
getPropertyDescription()
Gets the metadata property description.
|
int |
getPropertyID()
Gets the ID that identifies the property (see
CSMetaDataProperty ) that this metadata value is associated
with. |
java.lang.String |
getPropertyName()
Gets the metadata property name.
|
java.lang.String |
getPropertySearchField()
Gets the metadata property search field.
|
java.lang.Object |
getRelatedByKey()
Returns the state of the relationship direction after fetching related metadata using the
CSMetaDataMultiple.setRelatedBothWays(boolean) method that matched this metadata. |
java.lang.String |
getRelatedMetaDataOptionalIDs()
Gets the list of metadata value IDs specified via the
CSMetaDataMultiple.setRelatedMetaDataOptionalIDs(String) method that matched for this metadata. |
java.lang.String |
getValue()
Gets the metadata value.
|
int |
getValueID()
Gets the ID of the metadata value.
|
void |
setDescription(java.lang.String strDescription)
Sets the metadata description.
|
void |
setExternalSchemaID(java.lang.String strValue)
Sets the External Schema ID.
|
void |
setExternalSchemaName(java.lang.String strValue)
Sets the External Schema name.
|
void |
setGroupID(int nGroupID)
Sets the ID that identifies the group that this metadata value is associated with.
|
void |
setGroupName(java.lang.String strGroupName)
Sets the metadata group name.
|
void |
setGroupSearchField(java.lang.String strSearchField)
Sets the metadata group search field.
|
void |
setKnownTerms(java.lang.String strKnownTerms)
Sets the known terms (synonyms).
|
void |
setLocalTerms(java.lang.String strLocalTerms)
Sets the local terms (synonyms).
|
void |
setPropertyDescription(java.lang.String strPropertyDesc)
Sets the metadata property description.
|
void |
setPropertyID(int nPropertyID)
Sets the ID that identifies the property (see
CSMetaDataProperty ) that this metadata value is associated
with. |
void |
setPropertyName(java.lang.String strPropertyName)
Sets the metadata property name.
|
void |
setPropertySearchField(java.lang.String strPropertySearchField)
Sets the metadata property search field.
|
void |
setRelatedByKey(java.lang.Object bRelatedByKey)
Sets the state of the relationship direction after fetching related metadata using the
CSMetaDataMultiple.setRelatedBothWays(boolean) method that matched this metadata. |
void |
setValue(java.lang.String strValue)
Sets the actual metadata value.
|
void |
setValueID(int nValueID)
Sets the ID of the metadata value.
|
java.lang.String |
toString()
Outputs the contents of this
CSMetaDataContent object to a String object in a
user-friendly format. |
clone, getID, setID, unset
public CSMetaDataContent()
CSMetaDataContent
object.public void setGroupID(int nGroupID)
nGroupID
- the metadata group ID.public int getGroupID()
public void setPropertyID(int nPropertyID)
CSMetaDataProperty
) that this metadata value is associated
with.
nPropertyID
- the metadata property ID.public int getPropertyID()
CSMetaDataProperty
) that this metadata value is associated
with.
public void setValueID(int nValueID)
nValueID
- the numeric identifier of the metadata value.public int getValueID()
public void setValue(java.lang.String strValue)
strValue
- the metadata value.public java.lang.String getValue()
public void setDescription(java.lang.String strDescription)
strDescription
- the metadata description.public java.lang.String getDescription()
public void setExternalSchemaName(java.lang.String strValue)
strValue
- The name of the external schemapublic java.lang.String getExternalSchemaName()
public void setExternalSchemaID(java.lang.String strValue)
strValue
- The ID of the external schemapublic java.lang.String getExternalSchemaID()
public void setKnownTerms(java.lang.String strKnownTerms)
strKnownTerms
- The set of known synonyms to assign to the metadata valuepublic java.lang.String getKnownTerms()
public void setLocalTerms(java.lang.String strLocalTerms)
strLocalTerms
- The set of local synonyms to assign to the metadata valuepublic java.lang.String getLocalTerms()
public void setGroupName(java.lang.String strGroupName)
strGroupName
- the metadata group name.public java.lang.String getGroupName()
public void setGroupSearchField(java.lang.String strSearchField)
strSearchField
- the metadata group search field.public java.lang.String getGroupSearchField()
public void setPropertyName(java.lang.String strPropertyName)
strPropertyName
- the metadata property name.public java.lang.String getPropertyName()
public void setPropertyDescription(java.lang.String strPropertyDesc)
strPropertyDesc
- the description of the metadata property.public java.lang.String getPropertySearchField()
public void setPropertySearchField(java.lang.String strPropertySearchField)
strPropertySearchField
- the search field for the the metadata property.public java.lang.String getPropertyDescription()
public java.lang.String getRelatedMetaDataOptionalIDs()
CSMetaDataMultiple.setRelatedMetaDataOptionalIDs(String)
method that matched for this metadata. This list
will only be populated when the setRelatedMetaDataOptionalIDs
method is specified as key
information.
public void setRelatedByKey(java.lang.Object bRelatedByKey)
CSMetaDataMultiple.setRelatedBothWays(boolean)
method that matched this metadata. This should only be set
when the CSMetaDataMultiple.get()
method uses an ArticleID, MediaID, EventID or MetadataID value as a key
and should only be set Boolean.FALSE
when this metadata value relates the MetadataID used as key
information.
The flag state has the following meanings: Boolean.True => this value was related by the supplied key item, Boolean.FALSE => this value relates the supplied key item
bRelatedByKey
- the Boolean value or null if the use of this flag is inappropriate for the supplied key information.public java.lang.Object getRelatedByKey()
CSMetaDataMultiple.setRelatedBothWays(boolean)
method that matched this metadata. This will only be
populated when the CSMetaDataMultiple.get()
method uses an ArticleID, MediaID, EventID or MetadataID
value as a key and will only be set Boolean.FALSE
when this metadata value relates the MetadataID
used as key information.
public java.lang.String toString()
CSMetaDataContent
object to a String
object in a
user-friendly format.
toString
in class CSItemContent
String
containing the user-friendly output.public boolean equals(java.lang.Object obj)
CSMetaDataContent
object is the same as that
contained within the one supplied. Note that the key data used for searching is not tested for equality.
equals
in class CSItemContent
obj
- the CSMetaDataContent
to be tested for equality.true
if the data matches, false
otherwise.Copyright © 2022 Goss Interactive Ltd. All Rights Reserved.