public abstract class AbstractTagUtilities
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
protected class |
AbstractTagUtilities.DateRange |
Modifier and Type | Field and Description |
---|---|
protected TagManagerBase |
tagManager |
Constructor and Description |
---|
AbstractTagUtilities(TagManagerBase tagManager) |
Modifier and Type | Method and Description |
---|---|
protected TagPath |
adjustPath(java.lang.String provider,
TagPath path) |
BrowseResults |
browseHistoricalTags(org.python.core.PyObject[] pyArgs,
java.lang.String[] keywords) |
protected abstract BrowseResults |
browseHistoricalTagsImpl(QualifiedPath root,
BrowseFilter filter) |
protected abstract boolean |
canEditForProvider(java.lang.String provider) |
boolean |
exists(java.lang.String tagPathStr) |
protected Aggregate |
getAggregateFor(java.lang.String value)
Returns an aggregate for the string.
|
Tag |
getTag(java.lang.String tagPathStr) |
protected TagManagerBase |
getTagManager() |
java.lang.Object |
getTagValue(java.lang.String tagPathStr)
Deprecated.
use read() instead. Implementation needs to be left here for backwards compatibility.
|
java.lang.Object[] |
getTagValues(java.lang.String[] tagPaths)
Deprecated.
use readAll() instead. Implementation needs to be left here for backwards compatibility.
|
protected abstract java.util.List<TagValue> |
getTagValuesImpl(java.util.List<TagPath> paths)
Bulk implementation of retrieving tag values.
|
protected abstract TypeManager |
getTypeManager(java.lang.String provider) |
protected AbstractTagUtilities.DateRange |
interpretRange(PyArgumentMap args) |
void |
loadFromFile(java.lang.String filePath,
java.lang.String providerName,
int mode)
Imports the tag file at the provided path into the specified provider.
|
protected static TagPath |
parseTagPath(java.lang.String path)
Parses the tag path, using some special values from ScriptContext when appropriate for the default source, and to
de-relativize if possible.
|
Dataset |
queryTagCalculations(org.python.core.PyObject[] objects,
java.lang.String[] keywords) |
protected abstract Dataset |
queryTagCalculationsImpl(java.util.List<QualifiedPath> paths,
java.util.List<Aggregate> colAggModes,
java.util.Date startDate,
java.util.Date endDate,
java.util.List<java.lang.String> aliases,
Flags queryFlags) |
Dataset |
queryTagDensity(org.python.core.PyObject[] objects,
java.lang.String[] keywords) |
protected abstract Dataset |
queryTagDensityImpl(java.util.List<QualifiedPath> paths,
java.util.Date startDate,
java.util.Date endDate) |
Dataset |
queryTagHistory(org.python.core.PyObject[] objects,
java.lang.String[] keywords) |
protected abstract Dataset |
queryTagHistoryImpl(java.util.List<QualifiedPath> paths,
java.util.Date startDate,
java.util.Date endDate,
int returnSize,
Aggregate aggregationMode,
ReturnFormat format,
java.util.List<java.lang.String> aliases,
java.util.List<Aggregate> colAggModes,
Flags queryFlags,
int timeout) |
QualifiedValue |
read(java.lang.String tagPathStr) |
QualifiedValue[] |
readAll(java.lang.String[] tagPathsArr) |
protected QualifiedPath |
toQualifiedPathFromHistoricalString(java.lang.String path) |
int |
write(org.python.core.PyObject[] objects,
java.lang.String[] keywords)
Writes a value to a tag asynchronously.
|
int[] |
writeAll(java.lang.String[] tagPaths,
java.lang.Object[] values) |
void |
writeAllSynchronous(java.lang.String[] tagPathStr,
java.lang.Object[] value) |
void |
writeAllSynchronous(java.lang.String[] tagPaths,
java.lang.Object[] values,
int timeout) |
void |
writeSynchronous(java.lang.String tagPathStr,
java.lang.Object value) |
void |
writeSynchronous(java.lang.String tagPathStr,
java.lang.Object value,
int timeout) |
int |
writeToTag(java.lang.String tagPathStr,
java.lang.Object value)
Deprecated.
|
int |
writeToTag(java.lang.String tagPathStr,
java.lang.Object value,
boolean suppressErrors)
Deprecated.
|
protected abstract int |
writeToTagImpl(TagPath tagPath,
java.lang.Object value,
boolean suppressErrors) |
int[] |
writeToTags(java.lang.String[] tagPaths,
java.lang.Object[] values)
Deprecated.
|
protected abstract int[] |
writeToTagsImpl(java.util.List<TagPath> paths,
java.util.List<java.lang.Object> values)
Bulk implementation of writing to tags.
|
protected abstract void |
writeToTagsSynchronousImpl(java.util.List<TagPath> paths,
java.util.List<java.lang.Object> values,
int timeout) |
void |
writeToTagSynchronous(java.lang.String tagPathStr,
java.lang.Object value)
Deprecated.
|
void |
writeToTagSynchronous(java.lang.String tagPathStr,
java.lang.Object value,
int timeout)
Deprecated.
|
protected abstract void |
writeToTagSynchronousImpl(TagPath tagPath,
java.lang.Object value,
int timeout) |
protected TagManagerBase tagManager
public AbstractTagUtilities(TagManagerBase tagManager)
protected static TagPath parseTagPath(java.lang.String path) throws java.io.IOException
java.io.IOException
protected TagManagerBase getTagManager()
public Tag getTag(java.lang.String tagPathStr)
@Deprecated public java.lang.Object getTagValue(java.lang.String tagPathStr)
tagPathStr
- @Deprecated public java.lang.Object[] getTagValues(java.lang.String[] tagPaths)
tagPaths
- public QualifiedValue read(java.lang.String tagPathStr)
public QualifiedValue[] readAll(java.lang.String[] tagPathsArr)
public boolean exists(java.lang.String tagPathStr)
@Deprecated public int writeToTag(java.lang.String tagPathStr, java.lang.Object value)
@Deprecated public final int writeToTag(java.lang.String tagPathStr, java.lang.Object value, boolean suppressErrors)
public final int write(org.python.core.PyObject[] objects, java.lang.String[] keywords)
@Deprecated public int[] writeToTags(java.lang.String[] tagPaths, java.lang.Object[] values)
public int[] writeAll(java.lang.String[] tagPaths, java.lang.Object[] values)
@Deprecated public final void writeToTagSynchronous(java.lang.String tagPathStr, java.lang.Object value)
@Deprecated public final void writeToTagSynchronous(java.lang.String tagPathStr, java.lang.Object value, int timeout)
public final void writeSynchronous(java.lang.String tagPathStr, java.lang.Object value)
public final void writeSynchronous(java.lang.String tagPathStr, java.lang.Object value, int timeout)
public final void writeAllSynchronous(java.lang.String[] tagPathStr, java.lang.Object[] value)
public final void writeAllSynchronous(java.lang.String[] tagPaths, java.lang.Object[] values, int timeout)
protected abstract java.util.List<TagValue> getTagValuesImpl(java.util.List<TagPath> paths) throws java.lang.Exception
java.lang.Exception
protected abstract int[] writeToTagsImpl(java.util.List<TagPath> paths, java.util.List<java.lang.Object> values) throws java.lang.Exception
paths
- values
- java.lang.Exception
protected abstract int writeToTagImpl(TagPath tagPath, java.lang.Object value, boolean suppressErrors)
protected abstract void writeToTagSynchronousImpl(TagPath tagPath, java.lang.Object value, int timeout)
protected abstract void writeToTagsSynchronousImpl(java.util.List<TagPath> paths, java.util.List<java.lang.Object> values, int timeout) throws java.lang.Exception
java.lang.Exception
protected AbstractTagUtilities.DateRange interpretRange(PyArgumentMap args)
protected QualifiedPath toQualifiedPathFromHistoricalString(java.lang.String path)
public Dataset queryTagHistory(org.python.core.PyObject[] objects, java.lang.String[] keywords) throws java.lang.Exception
java.lang.Exception
protected abstract Dataset queryTagHistoryImpl(java.util.List<QualifiedPath> paths, java.util.Date startDate, java.util.Date endDate, int returnSize, Aggregate aggregationMode, ReturnFormat format, java.util.List<java.lang.String> aliases, java.util.List<Aggregate> colAggModes, Flags queryFlags, int timeout) throws java.lang.Exception
java.lang.Exception
public Dataset queryTagCalculations(org.python.core.PyObject[] objects, java.lang.String[] keywords) throws java.lang.Exception
java.lang.Exception
protected abstract Dataset queryTagCalculationsImpl(java.util.List<QualifiedPath> paths, java.util.List<Aggregate> colAggModes, java.util.Date startDate, java.util.Date endDate, java.util.List<java.lang.String> aliases, Flags queryFlags) throws java.lang.Exception
java.lang.Exception
public Dataset queryTagDensity(org.python.core.PyObject[] objects, java.lang.String[] keywords) throws java.lang.Exception
java.lang.Exception
public BrowseResults browseHistoricalTags(org.python.core.PyObject[] pyArgs, java.lang.String[] keywords)
protected abstract BrowseResults browseHistoricalTagsImpl(QualifiedPath root, BrowseFilter filter)
protected abstract Dataset queryTagDensityImpl(java.util.List<QualifiedPath> paths, java.util.Date startDate, java.util.Date endDate) throws java.lang.Exception
java.lang.Exception
protected abstract TypeManager getTypeManager(java.lang.String provider)
protected abstract boolean canEditForProvider(java.lang.String provider)
public void loadFromFile(java.lang.String filePath, java.lang.String providerName, int mode) throws java.lang.Exception
filePath
- providerName
- mode
- java.lang.Exception
protected Aggregate getAggregateFor(java.lang.String value) throws java.lang.Exception
value
- java.lang.Exception