|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.endeca.itl.record.Record
public final class Record
Represents an Endeca Record that flows through the ITL process into the MDEX Engine. A Record consists of an unordered set of PropertyValue assignments e.g. [Endeca.Id=5, Name=Report.doc, LastModified=12/28/2009]. A Record may contain multiple PropertyValue assignments for a given property name e.g. [Endeca.Id=5, Name=Report.doc, LastModified=12/28/2009, AllowRead=Joe, AllowRead=Bob].
Records can have actions associated with them which are encoded in the Endeca.Action property.
See RecordType
for the set of valid actions.
PropertyValue
,
RecordType
Constructor Summary | |
---|---|
Record()
Creates a Record with no PropertyValues. |
|
Record(Record record)
Creates a Record with the same PropertyValues as the given Record. |
Method Summary | |
---|---|
void |
addPropertyValue(PropertyValue propertyValue)
Adds the given PropertyValue to the Record. |
boolean |
equals(Object other)
Equal iff both Records have the exact same PropertyValues. |
Set<String> |
getAllPropertyNames()
Returns the names of PropertyValues contained in this Record. |
PropertyValue[] |
getAllPropertyValues()
Returns all the PropertyValues contained by the Record. |
int |
getNumPropertyValues()
Returns the number of PropertyValues contained in this Record. |
int |
getNumPropertyValues(String propertyName)
Returns the number of PropertyValues with the given name. |
PropertyValue |
getPropertySingleValue(String propertyName)
Returns the PropertyValue with the given name if exactly one exists in the Record. |
PropertyValue[] |
getPropertyValues(String propertyName)
Returns all the PropertyValues with the given name. |
int |
hashCode()
|
boolean |
hasProperty(String propertyName)
Returns true if the Record contains a PropertyValue with the given name. |
boolean |
hasPropertyValue(PropertyValue propertyValue)
Returns true if the Record contains the given PropertyValue. |
void |
removePropertyValue(PropertyValue propertyValue)
Removes the given PropertyValue from the Record, if present. |
void |
removePropertyValues(String propertyName)
Removes all PropertyValues with the given name from the Record. |
void |
setAllPropertyValues(PropertyValue[] properties)
Set the Record's PropertyValues to the given PropertyValues. |
String |
toString()
|
String |
toTruncatedString(int maxStringLen)
Return properties with values truncated (and appended with an ellipse) if the values exceed the specified maximum. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Record()
public Record(Record record)
NullPointerException
- if the Record is nullMethod Detail |
---|
public void removePropertyValues(String propertyName)
NullPointerException
- if the property name is nullpublic void removePropertyValue(PropertyValue propertyValue)
NullPointerException
- if the PropertyValue is nullpublic void addPropertyValue(PropertyValue propertyValue)
NullPointerException
- if the property value is nullpublic PropertyValue[] getAllPropertyValues()
public void setAllPropertyValues(PropertyValue[] properties)
NullPointerException
- if the property values are nullpublic int getNumPropertyValues()
public int getNumPropertyValues(String propertyName)
public PropertyValue[] getPropertyValues(String propertyName)
NullPointerException
- if the property name is nullpublic Set<String> getAllPropertyNames()
public boolean hasProperty(String propertyName)
NullPointerException
- if the property name is nullpublic boolean hasPropertyValue(PropertyValue propertyValue)
NullPointerException
- if the PropertyValue is nullpublic PropertyValue getPropertySingleValue(String propertyName)
IllegalArgumentException
- If the Record contains multiple PropertyValues with
the given name
NullPointerException
- if the property name is nullpublic String toString()
toString
in class Object
public String toTruncatedString(int maxStringLen)
public boolean equals(Object other)
equals
in class Object
public int hashCode()
hashCode
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |