|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface INACandidateFieldMap
Deprecated as of 10.0. Provides access to the default value and candidate fields for a field in an NAClass.
INACandidateFieldMap is an interface on the NACandidateFieldMap object used to specify the default value and candidate field names for a particular field in an NAClass.
An NAClassCandidateFieldMap object holds an array of NACandidateFieldMap objects.
Within INAServer::Solve the information provided by INACandidateFieldMap is applied to an NAClassFieldMap object prior to loading network locations to specify the values of the network locations based on these default values and candidate fields.
Method Summary | |
---|---|
IStringArray |
getCandidateFieldNames()
CandidateFieldNames for the field. |
Object |
getDefaultValue()
Default value for the field. |
String |
getFieldName()
Name of the field. |
void |
setCandidateFieldNamesByRef(IStringArray ppCandidateFieldNames)
CandidateFieldNames for the field. |
void |
setDefaultValue(Object defaultValue)
Default value for the field. |
void |
setFieldName(String name)
Name of the field. |
Method Detail |
---|
String getFieldName() throws IOException, AutomationException
The FieldName is the name of the field that the default value and candidate field names apply to.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setFieldName(String name) throws IOException, AutomationException
The FieldName is the name of the field that the default value and candidate field names apply to.
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.Object getDefaultValue() throws IOException, AutomationException
The DefaultValue specifies the value to use for this field of the network location. This value will be overridden if a candidate field name matches a field on the input cursor.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setDefaultValue(Object defaultValue) throws IOException, AutomationException
The DefaultValue specifies the value to use for this field of the network location. This value will be overridden if a candidate field name matches a field on the input cursor.
defaultValue
- A Variant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IStringArray getCandidateFieldNames() throws IOException, AutomationException
The CandidateFieldNames specifies the possible field names to try to match with the input cursor. If the input cursor has a field with a name in the CandidateFieldNames, it uses the value from this field on the input feature to set the network location's field specified by FieldName.
If a candidate field name matches one of the input cursor's fields, the feature's field value overrides the DefaultValue unless the value is NULL in which case it uses the DefaultValue.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setCandidateFieldNamesByRef(IStringArray ppCandidateFieldNames) throws IOException, AutomationException
The CandidateFieldNames specifies the possible field names to try to match with the input cursor. If the input cursor has a field with a name in the CandidateFieldNames, it uses the value from this field on the input feature to set the network location's field specified by FieldName.
If a candidate field name matches one of the input cursor's fields, the feature's field value overrides the DefaultValue unless the value is NULL in which case it uses the DefaultValue.
ppCandidateFieldNames
- A reference to a com.esri.arcgis.system.IStringArray (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |